From 3e8bf5aedf0e80c40e930fe8e75ca0b159366b20 Mon Sep 17 00:00:00 2001 From: Nate Ferrell Date: Sat, 29 Feb 2020 10:56:34 -0600 Subject: [PATCH 1/6] added support for FallbackCredentialsFactory --- VaporShell/Private/ProcessRequest3.ps1 | 42 ++- VaporShell/Private/ProcessRequest4.ps1 | 40 ++- ...exaASKSkillAuthenticationConfiguration.ps1 | 10 +- .../Add-VSAlexaASKSkillOverrides.ps1 | 6 +- .../Add-VSAlexaASKSkillSkillPackage.ps1 | 14 +- .../Add-VSAmazonMQBrokerConfigurationId.ps1 | 8 +- .../Add-VSAmazonMQBrokerEncryptionOptions.ps1 | 8 +- .../Add-VSAmazonMQBrokerLogList.ps1 | 8 +- .../Add-VSAmazonMQBrokerMaintenanceWindow.ps1 | 10 +- .../Add-VSAmazonMQBrokerTagsEntry.ps1 | 8 +- .../Add-VSAmazonMQBrokerUser.ps1 | 12 +- ...onfigurationAssociationConfigurationId.ps1 | 8 +- .../Add-VSAmazonMQConfigurationTagsEntry.ps1 | 8 +- ...d-VSAmplifyAppAutoBranchCreationConfig.ps1 | 22 +- .../Add-VSAmplifyAppBasicAuthConfig.ps1 | 10 +- .../Add-VSAmplifyAppCustomRule.ps1 | 12 +- .../Add-VSAmplifyAppEnvironmentVariable.ps1 | 8 +- .../Add-VSAmplifyBranchBasicAuthConfig.ps1 | 10 +- ...Add-VSAmplifyBranchEnvironmentVariable.ps1 | 8 +- .../Add-VSAmplifyDomainSubDomainSetting.ps1 | 8 +- .../Add-VSApiGatewayApiKeyStageKey.ps1 | 8 +- ...VSApiGatewayDeploymentAccessLogSetting.ps1 | 8 +- ...dd-VSApiGatewayDeploymentCanarySetting.ps1 | 10 +- ...ewayDeploymentDeploymentCanarySettings.ps1 | 11 +- ...dd-VSApiGatewayDeploymentMethodSetting.ps1 | 24 +- ...VSApiGatewayDeploymentStageDescription.ps1 | 43 ++- ...-VSApiGatewayDocumentationPartLocation.ps1 | 16 +- ...GatewayDomainNameEndpointConfiguration.ps1 | 6 +- .../Add-VSApiGatewayMethodIntegration.ps1 | 46 ++- ...-VSApiGatewayMethodIntegrationResponse.ps1 | 21 +- .../Add-VSApiGatewayMethodMethodResponse.ps1 | 10 +- ...ApiGatewayRestApiEndpointConfiguration.ps1 | 11 +- .../Add-VSApiGatewayRestApiS3Location.ps1 | 14 +- .../Add-VSApiGatewayStageAccessLogSetting.ps1 | 8 +- .../Add-VSApiGatewayStageCanarySetting.ps1 | 13 +- .../Add-VSApiGatewayStageMethodSetting.ps1 | 24 +- .../Add-VSApiGatewayUsagePlanApiStage.ps1 | 11 +- ...Add-VSApiGatewayUsagePlanQuotaSettings.ps1 | 10 +- ...-VSApiGatewayUsagePlanThrottleSettings.ps1 | 8 +- ...wayV2DomainNameDomainNameConfiguration.ps1 | 10 +- ...SApiGatewayV2RouteParameterConstraints.ps1 | 6 +- ...wayV2RouteResponseParameterConstraints.ps1 | 6 +- ...d-VSApiGatewayV2StageAccessLogSettings.ps1 | 8 +- .../Add-VSApiGatewayV2StageRouteSettings.ps1 | 14 +- .../Add-VSAppMeshMeshEgressFilter.ps1 | 6 +- .../Add-VSAppMeshMeshMeshSpec.ps1 | 6 +- .../Add-VSAppMeshRouteHeaderMatchMethod.ps1 | 14 +- .../Add-VSAppMeshRouteHttpRoute.ps1 | 10 +- .../Add-VSAppMeshRouteHttpRouteAction.ps1 | 6 +- .../Add-VSAppMeshRouteHttpRouteHeader.ps1 | 10 +- .../Add-VSAppMeshRouteHttpRouteMatch.ps1 | 12 +- .../Add-VSAppMeshRouteMatchRange.ps1 | 8 +- .../Add-VSAppMeshRouteRouteSpec.ps1 | 14 +- .../Add-VSAppMeshRouteTcpRoute.ps1 | 6 +- .../Add-VSAppMeshRouteTcpRouteAction.ps1 | 6 +- .../Add-VSAppMeshRouteWeightedTarget.ps1 | 8 +- .../Add-VSAppMeshVirtualNodeAccessLog.ps1 | 6 +- ...irtualNodeAwsCloudMapInstanceAttribute.ps1 | 8 +- ...VirtualNodeAwsCloudMapServiceDiscovery.ps1 | 10 +- .../Add-VSAppMeshVirtualNodeBackend.ps1 | 6 +- ...SAppMeshVirtualNodeDnsServiceDiscovery.ps1 | 6 +- .../Add-VSAppMeshVirtualNodeFileAccessLog.ps1 | 7 +- .../Add-VSAppMeshVirtualNodeHealthCheck.ps1 | 18 +- .../Add-VSAppMeshVirtualNodeListener.ps1 | 8 +- .../Add-VSAppMeshVirtualNodeLogging.ps1 | 6 +- .../Add-VSAppMeshVirtualNodePortMapping.ps1 | 8 +- ...d-VSAppMeshVirtualNodeServiceDiscovery.ps1 | 8 +- ...dd-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 | 12 +- ...ppMeshVirtualNodeVirtualServiceBackend.ps1 | 6 +- .../Add-VSAppMeshVirtualRouterPortMapping.ps1 | 8 +- ...MeshVirtualRouterVirtualRouterListener.ps1 | 6 +- ...SAppMeshVirtualRouterVirtualRouterSpec.ps1 | 6 +- ...rtualServiceVirtualNodeServiceProvider.ps1 | 6 +- ...ualServiceVirtualRouterServiceProvider.ps1 | 6 +- ...shVirtualServiceVirtualServiceProvider.ps1 | 8 +- ...ppMeshVirtualServiceVirtualServiceSpec.ps1 | 6 +- ...rectoryConfigServiceAccountCredentials.ps1 | 8 +- .../Add-VSAppStreamFleetComputeCapacity.ps1 | 6 +- .../Add-VSAppStreamFleetDomainJoinInfo.ps1 | 8 +- .../Add-VSAppStreamFleetVpcConfig.ps1 | 8 +- ...-VSAppStreamImageBuilderDomainJoinInfo.ps1 | 8 +- .../Add-VSAppStreamImageBuilderVpcConfig.ps1 | 8 +- ...dd-VSAppStreamStackApplicationSettings.ps1 | 8 +- .../Add-VSAppStreamStackStorageConnector.ps1 | 10 +- .../Add-VSAppStreamStackUserSetting.ps1 | 8 +- ...VSAppSyncDataSourceAuthorizationConfig.ps1 | 9 +- .../Add-VSAppSyncDataSourceAwsIamConfig.ps1 | 8 +- .../Add-VSAppSyncDataSourceDynamoDBConfig.ps1 | 14 +- ...VSAppSyncDataSourceElasticsearchConfig.ps1 | 8 +- .../Add-VSAppSyncDataSourceHttpConfig.ps1 | 8 +- .../Add-VSAppSyncDataSourceLambdaConfig.ps1 | 6 +- ...AppSyncDataSourceRdsHttpEndpointConfig.ps1 | 14 +- ...SyncDataSourceRelationalDatabaseConfig.ps1 | 8 +- ...hQLApiAdditionalAuthenticationProvider.ps1 | 10 +- ...QLApiAdditionalAuthenticationProviders.ps1 | 8 +- ...AppSyncGraphQLApiCognitoUserPoolConfig.ps1 | 10 +- .../Add-VSAppSyncGraphQLApiLogConfig.ps1 | 18 +- ...VSAppSyncGraphQLApiOpenIDConnectConfig.ps1 | 12 +- .../Add-VSAppSyncGraphQLApiTags.ps1 | 8 +- .../Add-VSAppSyncGraphQLApiUserPoolConfig.ps1 | 12 +- .../Add-VSAppSyncResolverPipelineConfig.ps1 | 6 +- ...lingScalableTargetScalableTargetAction.ps1 | 8 +- ...toScalingScalableTargetScheduledAction.ps1 | 20 +- ...utoScalingScalableTargetSuspendedState.ps1 | 10 +- ...ingPolicyCustomizedMetricSpecification.ps1 | 15 +- ...utoScalingScalingPolicyMetricDimension.ps1 | 8 +- ...ingPolicyPredefinedMetricSpecification.ps1 | 11 +- ...AutoScalingScalingPolicyStepAdjustment.ps1 | 18 +- ...ngPolicyStepScalingPolicyConfiguration.ps1 | 17 +- ...rgetTrackingScalingPolicyConfiguration.ps1 | 18 +- ...calingGroupLaunchTemplateSpecification.ps1 | 10 +- ...ScalingGroupLifecycleHookSpecification.ps1 | 20 +- ...alingAutoScalingGroupMetricsCollection.ps1 | 16 +- ...oScalingGroupNotificationConfiguration.ps1 | 13 +- ...AutoScalingAutoScalingGroupTagProperty.ps1 | 18 +- ...oScalingLaunchConfigurationBlockDevice.ps1 | 24 +- ...gLaunchConfigurationBlockDeviceMapping.ps1 | 16 +- ...alingPlansScalingPlanApplicationSource.ps1 | 8 +- ...gPlanCustomizedLoadMetricSpecification.ps1 | 24 +- ...anCustomizedScalingMetricSpecification.ps1 | 21 +- ...ScalingPlansScalingPlanMetricDimension.ps1 | 8 +- ...gPlanPredefinedLoadMetricSpecification.ps1 | 11 +- ...anPredefinedScalingMetricSpecification.ps1 | 11 +- ...lingPlansScalingPlanScalingInstruction.ps1 | 63 +++- ...VSAutoScalingPlansScalingPlanTagFilter.ps1 | 8 +- ...ScalingPlanTargetTrackingConfiguration.ps1 | 19 +- ...ingPolicyCustomizedMetricSpecification.ps1 | 15 +- ...utoScalingScalingPolicyMetricDimension.ps1 | 8 +- ...ingPolicyPredefinedMetricSpecification.ps1 | 13 +- ...AutoScalingScalingPolicyStepAdjustment.ps1 | 18 +- ...alingPolicyTargetTrackingConfiguration.ps1 | 12 +- ...BackupBackupPlanBackupPlanResourceType.ps1 | 8 +- ...BackupBackupPlanBackupRuleResourceType.ps1 | 20 +- ...SBackupBackupPlanLifecycleResourceType.ps1 | 8 +- ...upSelectionBackupSelectionResourceType.ps1 | 12 +- ...upBackupSelectionConditionResourceType.ps1 | 10 +- ...ackupBackupVaultNotificationObjectType.ps1 | 8 +- ...atchComputeEnvironmentComputeResources.ps1 | 36 ++- ...EnvironmentLaunchTemplateSpecification.ps1 | 11 +- ...SBatchJobDefinitionContainerProperties.ps1 | 41 ++- .../Add-VSBatchJobDefinitionDevice.ps1 | 10 +- .../Add-VSBatchJobDefinitionEnvironment.ps1 | 8 +- ...dd-VSBatchJobDefinitionLinuxParameters.ps1 | 6 +- .../Add-VSBatchJobDefinitionMountPoints.ps1 | 10 +- ...Add-VSBatchJobDefinitionNodeProperties.ps1 | 10 +- ...-VSBatchJobDefinitionNodeRangeProperty.ps1 | 8 +- ...SBatchJobDefinitionResourceRequirement.ps1 | 8 +- .../Add-VSBatchJobDefinitionRetryStrategy.ps1 | 6 +- .../Add-VSBatchJobDefinitionTimeout.ps1 | 6 +- .../Add-VSBatchJobDefinitionUlimit.ps1 | 10 +- .../Add-VSBatchJobDefinitionVolumes.ps1 | 8 +- .../Add-VSBatchJobDefinitionVolumesHost.ps1 | 6 +- ...VSBatchJobQueueComputeEnvironmentOrder.ps1 | 8 +- .../Add-VSBudgetsBudgetBudgetData.ps1 | 33 +- .../Add-VSBudgetsBudgetCostTypes.ps1 | 37 ++- .../Add-VSBudgetsBudgetNotification.ps1 | 22 +- ...dgetsBudgetNotificationWithSubscribers.ps1 | 8 +- .../Add-VSBudgetsBudgetSpend.ps1 | 12 +- .../Add-VSBudgetsBudgetSubscriber.ps1 | 13 +- .../Add-VSBudgetsBudgetTimePeriod.ps1 | 13 +- ...nagerCertificateDomainValidationOption.ps1 | 13 +- .../Add-VSCloud9EnvironmentEC2Repository.ps1 | 8 +- ...tyCloudFrontOriginAccessIdentityConfig.ps1 | 6 +- ...-VSCloudFrontDistributionCacheBehavior.ps1 | 61 +++- .../Add-VSCloudFrontDistributionCookies.ps1 | 11 +- ...udFrontDistributionCustomErrorResponse.ps1 | 26 +- ...oudFrontDistributionCustomOriginConfig.ps1 | 18 +- ...dFrontDistributionDefaultCacheBehavior.ps1 | 46 ++- ...oudFrontDistributionDistributionConfig.ps1 | 57 +++- ...SCloudFrontDistributionForwardedValues.ps1 | 17 +- ...VSCloudFrontDistributionGeoRestriction.ps1 | 13 +- ...tDistributionLambdaFunctionAssociation.ps1 | 13 +- .../Add-VSCloudFrontDistributionLogging.ps1 | 10 +- .../Add-VSCloudFrontDistributionOrigin.ps1 | 33 +- ...oudFrontDistributionOriginCustomHeader.ps1 | 8 +- ...d-VSCloudFrontDistributionRestrictions.ps1 | 6 +- ...VSCloudFrontDistributionS3OriginConfig.ps1 | 12 +- ...loudFrontDistributionViewerCertificate.ps1 | 46 ++- ...CloudFrontStreamingDistributionLogging.ps1 | 10 +- ...loudFrontStreamingDistributionS3Origin.ps1 | 12 +- ...istributionStreamingDistributionConfig.ps1 | 18 +- ...ontStreamingDistributionTrustedSigners.ps1 | 16 +- .../Add-VSCloudTrailTrailDataResource.ps1 | 39 ++- .../Add-VSCloudTrailTrailEventSelector.ps1 | 14 +- .../Add-VSCloudWatchAlarmDimension.ps1 | 8 +- .../Add-VSCloudWatchAlarmMetric.ps1 | 10 +- .../Add-VSCloudWatchAlarmMetricDataQuery.ps1 | 16 +- .../Add-VSCloudWatchAlarmMetricStat.ps1 | 13 +- ...CloudWatchAnomalyDetectorConfiguration.ps1 | 9 +- ...d-VSCloudWatchAnomalyDetectorDimension.ps1 | 8 +- .../Add-VSCloudWatchAnomalyDetectorRange.ps1 | 8 +- .../Add-VSCodeBuildProjectArtifacts.ps1 | 52 ++- ...VSCodeBuildProjectCloudWatchLogsConfig.ps1 | 12 +- .../Add-VSCodeBuildProjectEnvironment.ps1 | 38 ++- ...-VSCodeBuildProjectEnvironmentVariable.ps1 | 13 +- .../Add-VSCodeBuildProjectFilterGroup.ps1 | 8 +- ...-VSCodeBuildProjectGitSubmodulesConfig.ps1 | 6 +- .../Add-VSCodeBuildProjectLogsConfig.ps1 | 8 +- .../Add-VSCodeBuildProjectProjectCache.ps1 | 25 +- ...eBuildProjectProjectFileSystemLocation.ps1 | 118 +++++++ ...VSCodeBuildProjectProjectSourceVersion.ps1 | 13 +- .../Add-VSCodeBuildProjectProjectTriggers.ps1 | 8 +- ...d-VSCodeBuildProjectRegistryCredential.ps1 | 13 +- .../Add-VSCodeBuildProjectS3LogsConfig.ps1 | 12 +- .../Add-VSCodeBuildProjectSource.ps1 | 37 ++- .../Add-VSCodeBuildProjectSourceAuth.ps1 | 10 +- .../Add-VSCodeBuildProjectVpcConfig.ps1 | 10 +- .../Add-VSCodeBuildProjectWebhookFilter.ps1 | 25 +- .../Add-VSCodeCommitRepositoryCode.ps1 | 6 +- ...SCodeCommitRepositoryRepositoryTrigger.ps1 | 16 +- .../Add-VSCodeCommitRepositoryS3.ps1 | 10 +- ...loyDeploymentConfigMinimumHealthyHosts.ps1 | 13 +- .../Add-VSCodeDeployDeploymentGroupAlarm.ps1 | 6 +- ...eployDeploymentGroupAlarmConfiguration.ps1 | 12 +- ...ploymentGroupAutoRollbackConfiguration.ps1 | 8 +- ...-VSCodeDeployDeploymentGroupDeployment.ps1 | 13 +- ...deDeployDeploymentGroupDeploymentStyle.ps1 | 9 +- ...SCodeDeployDeploymentGroupEC2TagFilter.ps1 | 13 +- ...d-VSCodeDeployDeploymentGroupEC2TagSet.ps1 | 7 +- ...ployDeploymentGroupEC2TagSetListObject.ps1 | 8 +- ...Add-VSCodeDeployDeploymentGroupELBInfo.ps1 | 9 +- ...odeDeployDeploymentGroupGitHubLocation.ps1 | 9 +- ...eDeployDeploymentGroupLoadBalancerInfo.ps1 | 16 +- ...eDeployDeploymentGroupOnPremisesTagSet.ps1 | 9 +- ...loymentGroupOnPremisesTagSetListObject.ps1 | 6 +- ...eDeployDeploymentGroupRevisionLocation.ps1 | 13 +- ...-VSCodeDeployDeploymentGroupS3Location.ps1 | 21 +- ...d-VSCodeDeployDeploymentGroupTagFilter.ps1 | 13 +- ...deDeployDeploymentGroupTargetGroupInfo.ps1 | 10 +- ...CodeDeployDeploymentGroupTriggerConfig.ps1 | 10 +- ...ipelineCustomActionTypeArtifactDetails.ps1 | 8 +- ...ustomActionTypeConfigurationProperties.ps1 | 22 +- ...VSCodePipelineCustomActionTypeSettings.ps1 | 12 +- ...SCodePipelinePipelineActionDeclaration.ps1 | 22 +- ...Add-VSCodePipelinePipelineActionTypeId.ps1 | 12 +- ...dd-VSCodePipelinePipelineArtifactStore.ps1 | 10 +- ...VSCodePipelinePipelineArtifactStoreMap.ps1 | 8 +- ...CodePipelinePipelineBlockerDeclaration.ps1 | 8 +- ...dd-VSCodePipelinePipelineEncryptionKey.ps1 | 8 +- ...dd-VSCodePipelinePipelineInputArtifact.ps1 | 7 +- ...d-VSCodePipelinePipelineOutputArtifact.ps1 | 8 +- ...VSCodePipelinePipelineStageDeclaration.ps1 | 10 +- ...-VSCodePipelinePipelineStageTransition.ps1 | 8 +- ...ipelineWebhookWebhookAuthConfiguration.ps1 | 8 +- ...VSCodePipelineWebhookWebhookFilterRule.ps1 | 8 +- .../Add-VSCodeStarGitHubRepositoryCode.ps1 | 6 +- .../Add-VSCodeStarGitHubRepositoryS3.ps1 | 10 +- ...itoIdentityPoolCognitoIdentityProvider.ps1 | 12 +- ...dd-VSCognitoIdentityPoolCognitoStreams.ps1 | 10 +- .../Add-VSCognitoIdentityPoolPushSync.ps1 | 8 +- ...oIdentityPoolRoleAttachmentMappingRule.ps1 | 13 +- ...oIdentityPoolRoleAttachmentRoleMapping.ps1 | 14 +- ...olRoleAttachmentRulesConfigurationType.ps1 | 6 +- ...VSCognitoUserPoolAdminCreateUserConfig.ps1 | 12 +- ...toUserPoolClientAnalyticsConfiguration.ps1 | 12 +- ...d-VSCognitoUserPoolDeviceConfiguration.ps1 | 8 +- ...dd-VSCognitoUserPoolEmailConfiguration.ps1 | 24 +- ...VSCognitoUserPoolInviteMessageTemplate.ps1 | 10 +- .../Add-VSCognitoUserPoolLambdaConfig.ps1 | 30 +- ...nitoUserPoolNumberAttributeConstraints.ps1 | 8 +- .../Add-VSCognitoUserPoolPasswordPolicy.ps1 | 17 +- .../Add-VSCognitoUserPoolPolicies.ps1 | 6 +- .../Add-VSCognitoUserPoolSchemaAttribute.ps1 | 19 +- .../Add-VSCognitoUserPoolSmsConfiguration.ps1 | 9 +- ...nitoUserPoolStringAttributeConstraints.ps1 | 8 +- ...Add-VSCognitoUserPoolUserAttributeType.ps1 | 8 +- .../Add-VSCognitoUserPoolUserPoolAddOns.ps1 | 6 +- ...itoUserPoolVerificationMessageTemplate.ps1 | 16 +- .../Add-VSConfigConfigRuleScope.ps1 | 12 +- .../Add-VSConfigConfigRuleSource.ps1 | 11 +- .../Add-VSConfigConfigRuleSourceDetail.ps1 | 17 +- ...tionAggregatorAccountAggregationSource.ps1 | 10 +- ...ggregatorOrganizationAggregationSource.ps1 | 10 +- ...figConfigurationRecorderRecordingGroup.ps1 | 32 +- ...hannelConfigSnapshotDeliveryProperties.ps1 | 28 +- ...nfigRuleOrganizationCustomRuleMetadata.ps1 | 26 +- ...figRuleOrganizationManagedRuleMetadata.ps1 | 21 +- ...ConfigurationRemediationParameterValue.ps1 | 8 +- ...gRemediationConfigurationResourceValue.ps1 | 6 +- ...figRemediationConfigurationStaticValue.ps1 | 6 +- .../Add-VSDAXClusterSSESpecification.ps1 | 6 +- .../Add-VSDLMLifecyclePolicyCreateRule.ps1 | 11 +- .../Add-VSDLMLifecyclePolicyPolicyDetails.ps1 | 14 +- .../Add-VSDLMLifecyclePolicyRetainRule.ps1 | 10 +- .../Add-VSDLMLifecyclePolicySchedule.ps1 | 20 +- .../Add-VSDMSEndpointDynamoDbSettings.ps1 | 38 ++- ...Add-VSDMSEndpointElasticsearchSettings.ps1 | 86 ++++- .../Add-VSDMSEndpointKinesisSettings.ps1 | 72 ++++- .../Add-VSDMSEndpointMongoDbSettings.ps1 | 222 ++++++++++++- .../Add-VSDMSEndpointS3Settings.ps1 | 18 +- .../Add-VSDataPipelinePipelineField.ps1 | 14 +- ...DataPipelinePipelineParameterAttribute.ps1 | 8 +- ...-VSDataPipelinePipelineParameterObject.ps1 | 8 +- ...d-VSDataPipelinePipelineParameterValue.ps1 | 8 +- ...d-VSDataPipelinePipelinePipelineObject.ps1 | 10 +- .../Add-VSDataPipelinePipelinePipelineTag.ps1 | 8 +- ...DirectoryServiceMicrosoftADVpcSettings.ps1 | 8 +- ...-VSDirectoryServiceSimpleADVpcSettings.ps1 | 8 +- ...Add-VSDynamoDBTableAttributeDefinition.ps1 | 11 +- ...dd-VSDynamoDBTableGlobalSecondaryIndex.ps1 | 17 +- .../Add-VSDynamoDBTableKeySchema.ps1 | 14 +- ...Add-VSDynamoDBTableLocalSecondaryIndex.ps1 | 14 +- ...BTablePointInTimeRecoverySpecification.ps1 | 6 +- .../Add-VSDynamoDBTableProjection.ps1 | 12 +- ...d-VSDynamoDBTableProvisionedThroughput.ps1 | 10 +- .../Add-VSDynamoDBTableSSESpecification.ps1 | 11 +- ...Add-VSDynamoDBTableStreamSpecification.ps1 | 10 +- ...VSDynamoDBTableTimeToLiveSpecification.ps1 | 8 +- ...EC2CapacityReservationTagSpecification.ps1 | 8 +- ...dpointCertificateAuthenticationRequest.ps1 | 6 +- ...VpnEndpointClientAuthenticationRequest.ps1 | 10 +- ...2ClientVpnEndpointConnectionLogOptions.ps1 | 10 +- ...tDirectoryServiceAuthenticationRequest.ps1 | 6 +- ...VSEC2ClientVpnEndpointTagSpecification.ps1 | 8 +- ...2FleetFleetLaunchTemplateConfigRequest.ps1 | 8 +- ...eetFleetLaunchTemplateOverridesRequest.ps1 | 16 +- ...leetLaunchTemplateSpecificationRequest.ps1 | 10 +- ...dd-VSEC2EC2FleetOnDemandOptionsRequest.ps1 | 6 +- .../Add-VSEC2EC2FleetSpotOptionsRequest.ps1 | 10 +- .../Add-VSEC2EC2FleetTagRequest.ps1 | 10 +- .../Add-VSEC2EC2FleetTagSpecification.ps1 | 8 +- ...leetTargetCapacitySpecificationRequest.ps1 | 12 +- .../Add-VSEC2InstanceAssociationParameter.ps1 | 8 +- .../Add-VSEC2InstanceBlockDeviceMapping.ps1 | 16 +- .../Add-VSEC2InstanceCpuOptions.ps1 | 8 +- .../Add-VSEC2InstanceCreditSpecification.ps1 | 6 +- .../Add-VSEC2InstanceEbs.ps1 | 25 +- ...d-VSEC2InstanceElasticGpuSpecification.ps1 | 6 +- ...EC2InstanceElasticInferenceAccelerator.ps1 | 8 +- .../Add-VSEC2InstanceInstanceIpv6Address.ps1 | 6 +- ...EC2InstanceLaunchTemplateSpecification.ps1 | 10 +- .../Add-VSEC2InstanceLicenseSpecification.ps1 | 6 +- .../Add-VSEC2InstanceNetworkInterface.ps1 | 29 +- .../Add-VSEC2InstanceNoDevice.ps1 | 4 +- ...2InstancePrivateIpAddressSpecification.ps1 | 8 +- .../Add-VSEC2InstanceSsmAssociation.ps1 | 8 +- .../Add-VSEC2InstanceVolume.ps1 | 8 +- ...-VSEC2LaunchTemplateBlockDeviceMapping.ps1 | 12 +- ...mplateCapacityReservationSpecification.ps1 | 10 +- ...aunchTemplateCapacityReservationTarget.ps1 | 6 +- .../Add-VSEC2LaunchTemplateCpuOptions.ps1 | 8 +- ...VSEC2LaunchTemplateCreditSpecification.ps1 | 6 +- .../Add-VSEC2LaunchTemplateEbs.ps1 | 20 +- ...2LaunchTemplateElasticGpuSpecification.ps1 | 6 +- ...-VSEC2LaunchTemplateHibernationOptions.ps1 | 7 +- ...-VSEC2LaunchTemplateIamInstanceProfile.ps1 | 8 +- ...EC2LaunchTemplateInstanceMarketOptions.ps1 | 8 +- .../Add-VSEC2LaunchTemplateIpv6Add.ps1 | 6 +- ...-VSEC2LaunchTemplateLaunchTemplateData.ps1 | 60 +++- ...nchTemplateElasticInferenceAccelerator.ps1 | 8 +- ...SEC2LaunchTemplateLicenseSpecification.ps1 | 6 +- .../Add-VSEC2LaunchTemplateMonitoring.ps1 | 6 +- ...dd-VSEC2LaunchTemplateNetworkInterface.ps1 | 32 +- .../Add-VSEC2LaunchTemplatePlacement.ps1 | 20 +- .../Add-VSEC2LaunchTemplatePrivateIpAdd.ps1 | 8 +- .../Add-VSEC2LaunchTemplateSpotOptions.ps1 | 14 +- ...dd-VSEC2LaunchTemplateTagSpecification.ps1 | 8 +- .../Add-VSEC2NetworkAclEntryIcmp.ps1 | 8 +- .../Add-VSEC2NetworkAclEntryPortRange.ps1 | 8 +- ...EC2NetworkInterfaceInstanceIpv6Address.ps1 | 6 +- ...InterfacePrivateIpAddressSpecification.ps1 | 8 +- .../Add-VSEC2SecurityGroupEgress.ps1 | 25 +- .../Add-VSEC2SecurityGroupIngress.ps1 | 29 +- .../Add-VSEC2SpotFleetBlockDeviceMapping.ps1 | 14 +- .../Add-VSEC2SpotFleetClassicLoadBalancer.ps1 | 6 +- ...EC2SpotFleetClassicLoadBalancersConfig.ps1 | 6 +- .../Add-VSEC2SpotFleetEbsBlockDevice.ps1 | 23 +- ...tFleetFleetLaunchTemplateSpecification.ps1 | 12 +- .../Add-VSEC2SpotFleetGroupIdentifier.ps1 | 6 +- ...otFleetIamInstanceProfileSpecification.ps1 | 6 +- .../Add-VSEC2SpotFleetInstanceIpv6Address.ps1 | 6 +- ...tInstanceNetworkInterfaceSpecification.ps1 | 27 +- ...Add-VSEC2SpotFleetLaunchTemplateConfig.ps1 | 8 +- ...-VSEC2SpotFleetLaunchTemplateOverrides.ps1 | 14 +- .../Add-VSEC2SpotFleetLoadBalancersConfig.ps1 | 8 +- ...SpotFleetPrivateIpAddressSpecification.ps1 | 8 +- ...2SpotFleetSpotFleetLaunchSpecification.ps1 | 40 ++- .../Add-VSEC2SpotFleetSpotFleetMonitoring.ps1 | 7 +- ...EC2SpotFleetSpotFleetRequestConfigData.ps1 | 31 +- ...SEC2SpotFleetSpotFleetTagSpecification.ps1 | 8 +- .../Add-VSEC2SpotFleetSpotPlacement.ps1 | 11 +- .../Add-VSEC2SpotFleetTargetGroup.ps1 | 6 +- .../Add-VSEC2SpotFleetTargetGroupsConfig.ps1 | 6 +- ...onnectionVpnTunnelOptionsSpecification.ps1 | 17 +- .../Add-VSECRRepositoryLifecyclePolicy.ps1 | 8 +- .../Add-VSECSServiceAwsVpcConfiguration.ps1 | 12 +- ...dd-VSECSServiceDeploymentConfiguration.ps1 | 10 +- .../Add-VSECSServiceLoadBalancer.ps1 | 17 +- .../Add-VSECSServiceNetworkConfiguration.ps1 | 7 +- .../Add-VSECSServicePlacementConstraint.ps1 | 8 +- .../Add-VSECSServicePlacementStrategy.ps1 | 8 +- .../Add-VSECSServiceServiceRegistry.ps1 | 12 +- ...VSECSTaskDefinitionContainerDefinition.ps1 | 137 +++++++- ...VSECSTaskDefinitionContainerDependency.ps1 | 16 +- .../Add-VSECSTaskDefinitionDevice.ps1 | 10 +- ...askDefinitionDockerVolumeConfiguration.ps1 | 15 +- .../Add-VSECSTaskDefinitionHealthCheck.ps1 | 23 +- .../Add-VSECSTaskDefinitionHostEntry.ps1 | 8 +- ...SECSTaskDefinitionHostVolumeProperties.ps1 | 7 +- ...-VSECSTaskDefinitionKernelCapabilities.ps1 | 11 +- .../Add-VSECSTaskDefinitionKeyValuePair.ps1 | 8 +- ...Add-VSECSTaskDefinitionLinuxParameters.ps1 | 22 +- ...dd-VSECSTaskDefinitionLogConfiguration.ps1 | 15 +- .../Add-VSECSTaskDefinitionMountPoint.ps1 | 10 +- .../Add-VSECSTaskDefinitionPortMapping.ps1 | 20 +- ...-VSECSTaskDefinitionProxyConfiguration.ps1 | 19 +- ...ECSTaskDefinitionRepositoryCredentials.ps1 | 7 +- ...VSECSTaskDefinitionResourceRequirement.ps1 | 8 +- .../Add-VSECSTaskDefinitionSecret.ps1 | 9 +- .../Add-VSECSTaskDefinitionSystemControl.ps1 | 12 +- ...itionTaskDefinitionPlacementConstraint.ps1 | 10 +- .../Add-VSECSTaskDefinitionTmpfs.ps1 | 11 +- .../Add-VSECSTaskDefinitionUlimit.ps1 | 10 +- .../Add-VSECSTaskDefinitionVolume.ps1 | 11 +- .../Add-VSECSTaskDefinitionVolumeFrom.ps1 | 8 +- ...dd-VSEFSFileSystemElasticFileSystemTag.ps1 | 8 +- .../Add-VSEKSClusterResourcesVpcConfig.ps1 | 8 +- .../Add-VSEMRClusterApplication.ps1 | 14 +- .../Add-VSEMRClusterAutoScalingPolicy.ps1 | 8 +- .../Add-VSEMRClusterBootstrapActionConfig.ps1 | 8 +- ...-VSEMRClusterCloudWatchAlarmDefinition.ps1 | 22 +- .../Add-VSEMRClusterConfiguration.ps1 | 12 +- .../Add-VSEMRClusterEbsBlockDeviceConfig.ps1 | 8 +- .../Add-VSEMRClusterEbsConfiguration.ps1 | 8 +- .../Add-VSEMRClusterHadoopJarStepConfig.ps1 | 12 +- .../Add-VSEMRClusterInstanceFleetConfig.ps1 | 18 +- ...nstanceFleetProvisioningSpecifications.ps1 | 8 +- .../Add-VSEMRClusterInstanceGroupConfig.ps1 | 22 +- .../Add-VSEMRClusterInstanceTypeConfig.ps1 | 18 +- ...Add-VSEMRClusterJobFlowInstancesConfig.ps1 | 38 ++- .../Add-VSEMRClusterKerberosAttributes.ps1 | 14 +- .../Add-VSEMRClusterKeyValue.ps1 | 8 +- .../Add-VSEMRClusterMetricDimension.ps1 | 8 +- .../Add-VSEMRClusterPlacementType.ps1 | 6 +- .../Add-VSEMRClusterScalingAction.ps1 | 8 +- .../Add-VSEMRClusterScalingConstraints.ps1 | 8 +- .../Add-VSEMRClusterScalingRule.ps1 | 12 +- .../Add-VSEMRClusterScalingTrigger.ps1 | 6 +- ...SEMRClusterScriptBootstrapActionConfig.ps1 | 8 +- ...lusterSimpleScalingPolicyConfiguration.ps1 | 10 +- ...MRClusterSpotProvisioningSpecification.ps1 | 12 +- .../Add-VSEMRClusterStepConfig.ps1 | 10 +- .../Add-VSEMRClusterVolumeSpecification.ps1 | 10 +- ...-VSEMRInstanceFleetConfigConfiguration.ps1 | 12 +- ...nstanceFleetConfigEbsBlockDeviceConfig.ps1 | 8 +- ...EMRInstanceFleetConfigEbsConfiguration.ps1 | 8 +- ...nstanceFleetProvisioningSpecifications.ps1 | 8 +- ...RInstanceFleetConfigInstanceTypeConfig.ps1 | 19 +- ...eetConfigSpotProvisioningSpecification.ps1 | 12 +- ...InstanceFleetConfigVolumeSpecification.ps1 | 10 +- ...MRInstanceGroupConfigAutoScalingPolicy.ps1 | 8 +- ...ceGroupConfigCloudWatchAlarmDefinition.ps1 | 22 +- ...-VSEMRInstanceGroupConfigConfiguration.ps1 | 14 +- ...nstanceGroupConfigEbsBlockDeviceConfig.ps1 | 8 +- ...EMRInstanceGroupConfigEbsConfiguration.ps1 | 8 +- ...SEMRInstanceGroupConfigMetricDimension.ps1 | 8 +- ...-VSEMRInstanceGroupConfigScalingAction.ps1 | 8 +- ...RInstanceGroupConfigScalingConstraints.ps1 | 8 +- ...dd-VSEMRInstanceGroupConfigScalingRule.ps1 | 12 +- ...VSEMRInstanceGroupConfigScalingTrigger.ps1 | 6 +- ...ConfigSimpleScalingPolicyConfiguration.ps1 | 10 +- ...InstanceGroupConfigVolumeSpecification.ps1 | 10 +- .../Add-VSEMRStepHadoopJarStepConfig.ps1 | 12 +- .../Add-VSEMRStepKeyValue.ps1 | 8 +- ...ReplicationGroupNodeGroupConfiguration.ps1 | 16 +- ...tionApplicationResourceLifecycleConfig.ps1 | 8 +- ...ationApplicationVersionLifecycleConfig.ps1 | 10 +- ...SElasticBeanstalkApplicationMaxAgeRule.ps1 | 10 +- ...lasticBeanstalkApplicationMaxCountRule.ps1 | 10 +- ...eanstalkApplicationVersionSourceBundle.ps1 | 8 +- ...tionTemplateConfigurationOptionSetting.ps1 | 14 +- ...nfigurationTemplateSourceConfiguration.ps1 | 8 +- ...asticBeanstalkEnvironmentOptionSetting.ps1 | 14 +- .../Add-VSElasticBeanstalkEnvironmentTier.ps1 | 17 +- ...lancingLoadBalancerAccessLoggingPolicy.ps1 | 13 +- ...gLoadBalancerAppCookieStickinessPolicy.ps1 | 8 +- ...ngLoadBalancerConnectionDrainingPolicy.ps1 | 8 +- ...alancingLoadBalancerConnectionSettings.ps1 | 6 +- ...icLoadBalancingLoadBalancerHealthCheck.ps1 | 19 +- ...ngLoadBalancerLBCookieStickinessPolicy.ps1 | 8 +- ...sticLoadBalancingLoadBalancerListeners.ps1 | 19 +- ...asticLoadBalancingLoadBalancerPolicies.ps1 | 14 +- ...VSElasticLoadBalancingV2ListenerAction.ps1 | 20 +- ...ingV2ListenerAuthenticateCognitoConfig.ps1 | 24 +- ...ancingV2ListenerAuthenticateOidcConfig.ps1 | 30 +- ...sticLoadBalancingV2ListenerCertificate.ps1 | 6 +- ...ancingV2ListenerCertificateCertificate.ps1 | 6 +- ...BalancingV2ListenerFixedResponseConfig.ps1 | 11 +- ...cLoadBalancingV2ListenerRedirectConfig.ps1 | 30 +- ...asticLoadBalancingV2ListenerRuleAction.ps1 | 20 +- ...2ListenerRuleAuthenticateCognitoConfig.ps1 | 24 +- ...ngV2ListenerRuleAuthenticateOidcConfig.ps1 | 30 +- ...ncingV2ListenerRuleFixedResponseConfig.ps1 | 11 +- ...alancingV2ListenerRuleHostHeaderConfig.ps1 | 7 +- ...alancingV2ListenerRuleHttpHeaderConfig.ps1 | 10 +- ...gV2ListenerRuleHttpRequestMethodConfig.ps1 | 7 +- ...lancingV2ListenerRulePathPatternConfig.ps1 | 7 +- ...lancingV2ListenerRuleQueryStringConfig.ps1 | 7 +- ...ncingV2ListenerRuleQueryStringKeyValue.ps1 | 8 +- ...dBalancingV2ListenerRuleRedirectConfig.ps1 | 30 +- ...adBalancingV2ListenerRuleRuleCondition.ps1 | 41 ++- ...dBalancingV2ListenerRuleSourceIpConfig.ps1 | 7 +- ...ingV2LoadBalancerLoadBalancerAttribute.ps1 | 18 +- ...adBalancingV2LoadBalancerSubnetMapping.ps1 | 8 +- ...asticLoadBalancingV2TargetGroupMatcher.ps1 | 8 +- ...alancingV2TargetGroupTargetDescription.ps1 | 14 +- ...ncingV2TargetGroupTargetGroupAttribute.ps1 | 19 +- .../Add-VSElasticsearchDomainEBSOptions.ps1 | 12 +- ...searchDomainElasticsearchClusterConfig.ps1 | 18 +- ...ticsearchDomainEncryptionAtRestOptions.ps1 | 8 +- ...earchDomainNodeToNodeEncryptionOptions.ps1 | 6 +- ...d-VSElasticsearchDomainSnapshotOptions.ps1 | 6 +- .../Add-VSElasticsearchDomainVPCOptions.ps1 | 8 +- ...ElasticsearchDomainZoneAwarenessConfig.ps1 | 7 +- .../Add-VSEventsEventBusPolicyCondition.ps1 | 10 +- .../Add-VSEventsRuleAwsVpcConfiguration.ps1 | 10 +- .../Add-VSEventsRuleEcsParameters.ps1 | 18 +- .../Add-VSEventsRuleInputTransformer.ps1 | 10 +- .../Add-VSEventsRuleKinesisParameters.ps1 | 8 +- .../Add-VSEventsRuleNetworkConfiguration.ps1 | 6 +- .../Add-VSEventsRuleRunCommandParameters.ps1 | 9 +- .../Add-VSEventsRuleRunCommandTarget.ps1 | 10 +- .../Add-VSEventsRuleSqsParameters.ps1 | 6 +- .../Add-VSEventsRuleTarget.ps1 | 25 +- ...Add-VSFSxFileSystemLustreConfiguration.ps1 | 18 +- ...dd-VSFSxFileSystemWindowsConfiguration.ps1 | 22 +- .../Add-VSGameLiftAliasRoutingStrategy.ps1 | 15 +- .../Add-VSGameLiftBuildS3Location.ps1 | 12 +- .../Add-VSGameLiftFleetIpPermission.ps1 | 12 +- .../Add-VSGlueClassifierCsvClassifier.ps1 | 18 +- .../Add-VSGlueClassifierGrokClassifier.ps1 | 12 +- .../Add-VSGlueClassifierJsonClassifier.ps1 | 8 +- .../Add-VSGlueClassifierXMLClassifier.ps1 | 10 +- .../Add-VSGlueConnectionConnectionInput.ps1 | 16 +- ...nnectionPhysicalConnectionRequirements.ps1 | 10 +- .../Add-VSGlueCrawlerJdbcTarget.ps1 | 10 +- .../Add-VSGlueCrawlerS3Target.ps1 | 8 +- .../Add-VSGlueCrawlerSchedule.ps1 | 6 +- .../Add-VSGlueCrawlerSchemaChangePolicy.ps1 | 8 +- .../Add-VSGlueCrawlerTargets.ps1 | 12 +- ...onSettingsConnectionPasswordEncryption.ps1 | 11 +- ...nSettingsDataCatalogEncryptionSettings.ps1 | 8 +- ...alogEncryptionSettingsEncryptionAtRest.ps1 | 8 +- .../Add-VSGlueDatabaseDatabaseInput.ps1 | 13 +- .../Add-VSGlueJobConnectionsList.ps1 | 6 +- .../Add-VSGlueJobExecutionProperty.ps1 | 6 +- .../Add-VSGlueJobJobCommand.ps1 | 10 +- ...VSGlueMLTransformFindMatchesParameters.ps1 | 17 +- .../Add-VSGlueMLTransformGlueTables.ps1 | 12 +- ...Add-VSGlueMLTransformInputRecordTables.ps1 | 6 +- ...d-VSGlueMLTransformTransformParameters.ps1 | 9 +- .../Add-VSGluePartitionColumn.ps1 | 10 +- .../Add-VSGluePartitionOrder.ps1 | 8 +- .../Add-VSGluePartitionPartitionInput.ps1 | 10 +- .../Add-VSGluePartitionSerdeInfo.ps1 | 10 +- .../Add-VSGluePartitionSkewedInfo.ps1 | 10 +- .../Add-VSGluePartitionStorageDescriptor.ps1 | 29 +- ...urityConfigurationCloudWatchEncryption.ps1 | 8 +- ...tyConfigurationEncryptionConfiguration.ps1 | 10 +- ...ityConfigurationJobBookmarksEncryption.ps1 | 8 +- ...SGlueSecurityConfigurationS3Encryption.ps1 | 8 +- ...GlueSecurityConfigurationS3Encryptions.ps1 | 8 +- .../Add-VSGlueTableColumn.ps1 | 10 +- .../Add-VSGlueTableOrder.ps1 | 8 +- .../Add-VSGlueTableSerdeInfo.ps1 | 10 +- .../Add-VSGlueTableSkewedInfo.ps1 | 10 +- .../Add-VSGlueTableStorageDescriptor.ps1 | 28 +- .../Add-VSGlueTableTableInput.ps1 | 26 +- .../Add-VSGlueTriggerAction.ps1 | 19 +- .../Add-VSGlueTriggerCondition.ps1 | 14 +- .../Add-VSGlueTriggerPredicate.ps1 | 8 +- ...GreengrassConnectorDefinitionConnector.ps1 | 12 +- ...orDefinitionConnectorDefinitionVersion.ps1 | 10 +- ...assConnectorDefinitionVersionConnector.ps1 | 12 +- .../Add-VSGreengrassCoreDefinitionCore.ps1 | 12 +- ...assCoreDefinitionCoreDefinitionVersion.ps1 | 10 +- ...-VSGreengrassCoreDefinitionVersionCore.ps1 | 12 +- ...Add-VSGreengrassDeviceDefinitionDevice.ps1 | 12 +- ...eviceDefinitionDeviceDefinitionVersion.ps1 | 10 +- ...reengrassDeviceDefinitionVersionDevice.ps1 | 12 +- ...engrassFunctionDefinitionDefaultConfig.ps1 | 6 +- ...reengrassFunctionDefinitionEnvironment.ps1 | 14 +- ...SGreengrassFunctionDefinitionExecution.ps1 | 14 +- ...VSGreengrassFunctionDefinitionFunction.ps1 | 10 +- ...unctionDefinitionFunctionConfiguration.ps1 | 19 +- ...ionDefinitionFunctionDefinitionVersion.ps1 | 12 +- ...FunctionDefinitionResourceAccessPolicy.ps1 | 12 +- ...dd-VSGreengrassFunctionDefinitionRunAs.ps1 | 12 +- ...FunctionDefinitionVersionDefaultConfig.ps1 | 6 +- ...ssFunctionDefinitionVersionEnvironment.ps1 | 14 +- ...rassFunctionDefinitionVersionExecution.ps1 | 14 +- ...grassFunctionDefinitionVersionFunction.ps1 | 10 +- ...DefinitionVersionFunctionConfiguration.ps1 | 19 +- ...nDefinitionVersionResourceAccessPolicy.ps1 | 12 +- ...eengrassFunctionDefinitionVersionRunAs.ps1 | 12 +- .../Add-VSGreengrassGroupGroupVersion.ps1 | 18 +- ...Add-VSGreengrassLoggerDefinitionLogger.ps1 | 14 +- ...oggerDefinitionLoggerDefinitionVersion.ps1 | 10 +- ...reengrassLoggerDefinitionVersionLogger.ps1 | 14 +- ...assResourceDefinitionGroupOwnerSetting.ps1 | 8 +- ...ourceDefinitionLocalDeviceResourceData.ps1 | 8 +- ...ourceDefinitionLocalVolumeResourceData.ps1 | 10 +- ...esourceDefinitionResourceDataContainer.ps1 | 18 +- ...rceDefinitionResourceDefinitionVersion.ps1 | 10 +- ...rassResourceDefinitionResourceInstance.ps1 | 11 +- ...tionS3MachineLearningModelResourceData.ps1 | 8 +- ...eMakerMachineLearningModelResourceData.ps1 | 8 +- ...nitionSecretsManagerSecretResourceData.ps1 | 8 +- ...urceDefinitionVersionGroupOwnerSetting.ps1 | 8 +- ...finitionVersionLocalDeviceResourceData.ps1 | 8 +- ...finitionVersionLocalVolumeResourceData.ps1 | 10 +- ...DefinitionVersionResourceDataContainer.ps1 | 18 +- ...ourceDefinitionVersionResourceInstance.ps1 | 11 +- ...sionS3MachineLearningModelResourceData.ps1 | 8 +- ...eMakerMachineLearningModelResourceData.ps1 | 8 +- ...ersionSecretsManagerSecretResourceData.ps1 | 8 +- ...rassSubscriptionDefinitionSubscription.ps1 | 12 +- ...efinitionSubscriptionDefinitionVersion.ps1 | 10 +- ...scriptionDefinitionVersionSubscription.ps1 | 12 +- .../Add-VSGuardDutyFilterCondition.ps1 | 14 +- .../Add-VSGuardDutyFilterFindingCriteria.ps1 | 8 +- .../Add-VSIAMGroupPolicy.ps1 | 10 +- .../Add-VSIAMRolePolicy.ps1 | 10 +- .../Add-VSIAMUserLoginProfile.ps1 | 8 +- .../Add-VSIAMUserPolicy.ps1 | 10 +- .../Add-VSIoT1ClickProjectDeviceTemplate.ps1 | 8 +- ...dd-VSIoT1ClickProjectPlacementTemplate.ps1 | 8 +- ...dd-VSIoTAnalyticsChannelChannelStorage.ps1 | 8 +- ...VSIoTAnalyticsChannelCustomerManagedS3.ps1 | 10 +- ...d-VSIoTAnalyticsChannelRetentionPeriod.ps1 | 8 +- ...-VSIoTAnalyticsChannelServiceManagedS3.ps1 | 4 +- .../Add-VSIoTAnalyticsDatasetAction.ps1 | 10 +- ...d-VSIoTAnalyticsDatasetContainerAction.ps1 | 12 +- ...yticsDatasetDatasetContentDeliveryRule.ps1 | 8 +- ...tDatasetContentDeliveryRuleDestination.ps1 | 8 +- ...yticsDatasetDatasetContentVersionValue.ps1 | 6 +- .../Add-VSIoTAnalyticsDatasetDeltaTime.ps1 | 8 +- .../Add-VSIoTAnalyticsDatasetFilter.ps1 | 6 +- ...VSIoTAnalyticsDatasetGlueConfiguration.ps1 | 8 +- ...tasetIotEventsDestinationConfiguration.ps1 | 8 +- ...SIoTAnalyticsDatasetOutputFileUriValue.ps1 | 6 +- .../Add-VSIoTAnalyticsDatasetQueryAction.ps1 | 8 +- ...TAnalyticsDatasetResourceConfiguration.ps1 | 8 +- ...d-VSIoTAnalyticsDatasetRetentionPeriod.ps1 | 8 +- ...yticsDatasetS3DestinationConfiguration.ps1 | 12 +- .../Add-VSIoTAnalyticsDatasetSchedule.ps1 | 6 +- .../Add-VSIoTAnalyticsDatasetTrigger.ps1 | 8 +- ...VSIoTAnalyticsDatasetTriggeringDataset.ps1 | 6 +- .../Add-VSIoTAnalyticsDatasetVariable.ps1 | 14 +- ...nalyticsDatasetVersioningConfiguration.ps1 | 8 +- ...IoTAnalyticsDatastoreCustomerManagedS3.ps1 | 10 +- ...SIoTAnalyticsDatastoreDatastoreStorage.ps1 | 8 +- ...VSIoTAnalyticsDatastoreRetentionPeriod.ps1 | 8 +- ...SIoTAnalyticsDatastoreServiceManagedS3.ps1 | 4 +- .../Add-VSIoTAnalyticsPipelineActivity.ps1 | 24 +- ...dd-VSIoTAnalyticsPipelineAddAttributes.ps1 | 11 +- .../Add-VSIoTAnalyticsPipelineChannel.ps1 | 10 +- .../Add-VSIoTAnalyticsPipelineDatastore.ps1 | 8 +- ...TAnalyticsPipelineDeviceRegistryEnrich.ps1 | 14 +- ...IoTAnalyticsPipelineDeviceShadowEnrich.ps1 | 14 +- .../Add-VSIoTAnalyticsPipelineFilter.ps1 | 10 +- .../Add-VSIoTAnalyticsPipelineLambda.ps1 | 13 +- .../Add-VSIoTAnalyticsPipelineMath.ps1 | 12 +- ...VSIoTAnalyticsPipelineRemoveAttributes.ps1 | 10 +- ...VSIoTAnalyticsPipelineSelectAttributes.ps1 | 10 +- .../Add-VSIoTEventsDetectorModelAction.ps1 | 24 +- ...Add-VSIoTEventsDetectorModelClearTimer.ps1 | 6 +- ...tsDetectorModelDetectorModelDefinition.ps1 | 8 +- .../Add-VSIoTEventsDetectorModelEvent.ps1 | 10 +- .../Add-VSIoTEventsDetectorModelFirehose.ps1 | 8 +- .../Add-VSIoTEventsDetectorModelIotEvents.ps1 | 6 +- ...SIoTEventsDetectorModelIotTopicPublish.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelLambda.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelOnEnter.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelOnExit.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelOnInput.ps1 | 8 +- ...Add-VSIoTEventsDetectorModelResetTimer.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelSetTimer.ps1 | 8 +- ...dd-VSIoTEventsDetectorModelSetVariable.ps1 | 8 +- .../Add-VSIoTEventsDetectorModelSns.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelSqs.ps1 | 8 +- .../Add-VSIoTEventsDetectorModelState.ps1 | 12 +- ...SIoTEventsDetectorModelTransitionEvent.ps1 | 12 +- .../Add-VSIoTEventsInputAttribute.ps1 | 7 +- .../Add-VSIoTEventsInputInputDefinition.ps1 | 6 +- .../Add-VSIoTThingAttributePayload.ps1 | 7 +- ...ngsGraphFlowTemplateDefinitionDocument.ps1 | 8 +- .../Add-VSIoTTopicRuleAction.ps1 | 32 +- ...dd-VSIoTTopicRuleCloudwatchAlarmAction.ps1 | 12 +- ...d-VSIoTTopicRuleCloudwatchMetricAction.ps1 | 16 +- .../Add-VSIoTTopicRuleDynamoDBAction.ps1 | 34 +- .../Add-VSIoTTopicRuleDynamoDBv2Action.ps1 | 10 +- .../Add-VSIoTTopicRuleElasticsearchAction.ps1 | 14 +- .../Add-VSIoTTopicRuleFirehoseAction.ps1 | 10 +- .../Add-VSIoTTopicRuleIotAnalyticsAction.ps1 | 8 +- .../Add-VSIoTTopicRuleKinesisAction.ps1 | 10 +- .../Add-VSIoTTopicRuleLambdaAction.ps1 | 6 +- .../Add-VSIoTTopicRulePutItemInput.ps1 | 6 +- .../Add-VSIoTTopicRuleRepublishAction.ps1 | 8 +- .../Add-VSIoTTopicRuleS3Action.ps1 | 10 +- .../Add-VSIoTTopicRuleSnsAction.ps1 | 10 +- .../Add-VSIoTTopicRuleSqsAction.ps1 | 10 +- .../Add-VSIoTTopicRuleStepFunctionsAction.ps1 | 10 +- .../Add-VSIoTTopicRuleTopicRulePayload.ps1 | 16 +- ...alyticsApplicationCSVMappingParameters.ps1 | 10 +- ...Add-VSKinesisAnalyticsApplicationInput.ps1 | 21 +- ...alyticsApplicationInputLambdaProcessor.ps1 | 9 +- ...isAnalyticsApplicationInputParallelism.ps1 | 6 +- ...pplicationInputProcessingConfiguration.ps1 | 6 +- ...KinesisAnalyticsApplicationInputSchema.ps1 | 10 +- ...lyticsApplicationJSONMappingParameters.ps1 | 6 +- ...alyticsApplicationKinesisFirehoseInput.ps1 | 8 +- ...nalyticsApplicationKinesisStreamsInput.ps1 | 8 +- ...sAnalyticsApplicationMappingParameters.ps1 | 8 +- ...ticsApplicationOutputDestinationSchema.ps1 | 6 +- ...ApplicationOutputKinesisFirehoseOutput.ps1 | 8 +- ...sApplicationOutputKinesisStreamsOutput.ps1 | 8 +- ...AnalyticsApplicationOutputLambdaOutput.ps1 | 9 +- ...inesisAnalyticsApplicationOutputOutput.ps1 | 14 +- ...inesisAnalyticsApplicationRecordColumn.ps1 | 10 +- ...inesisAnalyticsApplicationRecordFormat.ps1 | 8 +- ...eferenceDataSourceCSVMappingParameters.ps1 | 10 +- ...ferenceDataSourceJSONMappingParameters.ps1 | 6 +- ...onReferenceDataSourceMappingParameters.ps1 | 8 +- ...icationReferenceDataSourceRecordColumn.ps1 | 10 +- ...icationReferenceDataSourceRecordFormat.ps1 | 8 +- ...ReferenceDataSourceReferenceDataSource.ps1 | 10 +- ...tionReferenceDataSourceReferenceSchema.ps1 | 10 +- ...ferenceDataSourceS3ReferenceDataSource.ps1 | 10 +- ...pplicationApplicationCodeConfiguration.ps1 | 8 +- ...sV2ApplicationApplicationConfiguration.ps1 | 14 +- ...cationApplicationSnapshotConfiguration.ps1 | 6 +- ...yticsV2ApplicationCSVMappingParameters.ps1 | 10 +- ...csV2ApplicationCheckpointConfiguration.ps1 | 12 +- ...chLoggingOptionCloudWatchLoggingOption.ps1 | 6 +- ...nesisAnalyticsV2ApplicationCodeContent.ps1 | 10 +- ...ticsV2ApplicationEnvironmentProperties.ps1 | 6 +- ...plicationFlinkApplicationConfiguration.ps1 | 10 +- ...d-VSKinesisAnalyticsV2ApplicationInput.ps1 | 17 +- ...yticsV2ApplicationInputLambdaProcessor.ps1 | 7 +- ...AnalyticsV2ApplicationInputParallelism.ps1 | 6 +- ...pplicationInputProcessingConfiguration.ps1 | 6 +- ...nesisAnalyticsV2ApplicationInputSchema.ps1 | 10 +- ...ticsV2ApplicationJSONMappingParameters.ps1 | 6 +- ...yticsV2ApplicationKinesisFirehoseInput.ps1 | 6 +- ...lyticsV2ApplicationKinesisStreamsInput.ps1 | 6 +- ...nalyticsV2ApplicationMappingParameters.ps1 | 8 +- ...csV2ApplicationMonitoringConfiguration.ps1 | 10 +- ...csV2ApplicationOutputDestinationSchema.ps1 | 6 +- ...ApplicationOutputKinesisFirehoseOutput.ps1 | 6 +- ...2ApplicationOutputKinesisStreamsOutput.ps1 | 6 +- ...alyticsV2ApplicationOutputLambdaOutput.ps1 | 7 +- ...esisAnalyticsV2ApplicationOutputOutput.ps1 | 14 +- ...sV2ApplicationParallelismConfiguration.ps1 | 12 +- ...sisAnalyticsV2ApplicationPropertyGroup.ps1 | 8 +- ...esisAnalyticsV2ApplicationRecordColumn.ps1 | 10 +- ...esisAnalyticsV2ApplicationRecordFormat.ps1 | 8 +- ...eferenceDataSourceCSVMappingParameters.ps1 | 10 +- ...ferenceDataSourceJSONMappingParameters.ps1 | 6 +- ...onReferenceDataSourceMappingParameters.ps1 | 8 +- ...icationReferenceDataSourceRecordColumn.ps1 | 10 +- ...icationReferenceDataSourceRecordFormat.ps1 | 8 +- ...ReferenceDataSourceReferenceDataSource.ps1 | 10 +- ...tionReferenceDataSourceReferenceSchema.ps1 | 10 +- ...ferenceDataSourceS3ReferenceDataSource.ps1 | 8 +- ...nalyticsV2ApplicationS3ContentLocation.ps1 | 10 +- ...ApplicationSqlApplicationConfiguration.ps1 | 6 +- ...isFirehoseDeliveryStreamBufferingHints.ps1 | 8 +- ...DeliveryStreamCloudWatchLoggingOptions.ps1 | 12 +- ...nesisFirehoseDeliveryStreamCopyCommand.ps1 | 10 +- ...treamDataFormatConversionConfiguration.ps1 | 12 +- ...esisFirehoseDeliveryStreamDeserializer.ps1 | 8 +- ...iveryStreamElasticsearchBufferingHints.ps1 | 8 +- ...mElasticsearchDestinationConfiguration.ps1 | 26 +- ...eliveryStreamElasticsearchRetryOptions.ps1 | 6 +- ...eDeliveryStreamEncryptionConfiguration.ps1 | 8 +- ...reamExtendedS3DestinationConfiguration.ps1 | 28 +- ...sisFirehoseDeliveryStreamHiveJsonSerDe.ps1 | 6 +- ...DeliveryStreamInputFormatConfiguration.ps1 | 6 +- ...ehoseDeliveryStreamKMSEncryptionConfig.ps1 | 6 +- ...StreamKinesisStreamSourceConfiguration.ps1 | 8 +- ...isFirehoseDeliveryStreamOpenXJsonSerDe.ps1 | 11 +- ...SKinesisFirehoseDeliveryStreamOrcSerDe.ps1 | 26 +- ...eliveryStreamOutputFormatConfiguration.ps1 | 6 +- ...esisFirehoseDeliveryStreamParquetSerDe.ps1 | 16 +- ...eDeliveryStreamProcessingConfiguration.ps1 | 8 +- ...KinesisFirehoseDeliveryStreamProcessor.ps1 | 8 +- ...rehoseDeliveryStreamProcessorParameter.ps1 | 8 +- ...StreamRedshiftDestinationConfiguration.ps1 | 20 +- ...liveryStreamS3DestinationConfiguration.ps1 | 20 +- ...ehoseDeliveryStreamSchemaConfiguration.ps1 | 16 +- ...inesisFirehoseDeliveryStreamSerializer.ps1 | 8 +- ...ryStreamSplunkDestinationConfiguration.ps1 | 22 +- ...rehoseDeliveryStreamSplunkRetryOptions.ps1 | 6 +- .../Add-VSKinesisStreamStreamEncryption.ps1 | 17 +- ...-VSLakeFormationDataLakeSettingsAdmins.ps1 | 4 +- ...ationDataLakeSettingsDataLakePrincipal.ps1 | 6 +- ...eFormationPermissionsDataLakePrincipal.ps1 | 6 +- ...keFormationPermissionsDatabaseResource.ps1 | 6 +- ...Add-VSLakeFormationPermissionsResource.ps1 | 8 +- ...SLakeFormationPermissionsTableResource.ps1 | 8 +- ...VSLambdaAliasAliasRoutingConfiguration.ps1 | 6 +- .../Add-VSLambdaAliasVersionWeight.ps1 | 8 +- .../Add-VSLambdaFunctionCode.ps1 | 14 +- .../Add-VSLambdaFunctionDeadLetterConfig.ps1 | 6 +- .../Add-VSLambdaFunctionEnvironment.ps1 | 6 +- .../Add-VSLambdaFunctionTracingConfig.ps1 | 6 +- .../Add-VSLambdaFunctionVpcConfig.ps1 | 8 +- .../Add-VSLambdaLayerVersionContent.ps1 | 10 +- ...VSLogsMetricFilterMetricTransformation.ps1 | 12 +- .../Add-VSMSKClusterBrokerNodeGroupInfo.ps1 | 14 +- .../Add-VSMSKClusterClientAuthentication.ps1 | 6 +- .../Add-VSMSKClusterConfigurationInfo.ps1 | 8 +- .../Add-VSMSKClusterEBSStorageInfo.ps1 | 6 +- .../Add-VSMSKClusterEncryptionAtRest.ps1 | 6 +- .../Add-VSMSKClusterEncryptionInTransit.ps1 | 12 +- .../Add-VSMSKClusterEncryptionInfo.ps1 | 8 +- .../Add-VSMSKClusterStorageInfo.ps1 | 6 +- .../Add-VSMSKClusterTls.ps1 | 6 +- ...lockchainMemberApprovalThresholdPolicy.ps1 | 10 +- ...gedBlockchainMemberMemberConfiguration.ps1 | 10 +- ...ckchainMemberMemberFabricConfiguration.ps1 | 8 +- ...hainMemberMemberFrameworkConfiguration.ps1 | 6 +- ...edBlockchainMemberNetworkConfiguration.ps1 | 16 +- ...kchainMemberNetworkFabricConfiguration.ps1 | 6 +- ...ainMemberNetworkFrameworkConfiguration.ps1 | 6 +- ...-VSManagedBlockchainMemberVotingPolicy.ps1 | 6 +- ...ManagedBlockchainNodeNodeConfiguration.ps1 | 8 +- ...d-VSMediaLiveChannelAribSourceSettings.ps1 | 4 +- ...MediaLiveChannelAudioLanguageSelection.ps1 | 8 +- ...dd-VSMediaLiveChannelAudioPidSelection.ps1 | 6 +- .../Add-VSMediaLiveChannelAudioSelector.ps1 | 8 +- ...SMediaLiveChannelAudioSelectorSettings.ps1 | 8 +- .../Add-VSMediaLiveChannelCaptionSelector.ps1 | 10 +- ...ediaLiveChannelCaptionSelectorSettings.ps1 | 16 +- ...VSMediaLiveChannelDvbSubSourceSettings.ps1 | 6 +- ...MediaLiveChannelEmbeddedSourceSettings.ps1 | 12 +- ...Add-VSMediaLiveChannelHlsInputSettings.ps1 | 12 +- .../Add-VSMediaLiveChannelInputAttachment.ps1 | 10 +- .../Add-VSMediaLiveChannelInputSettings.ps1 | 22 +- ...d-VSMediaLiveChannelInputSpecification.ps1 | 10 +- ...lMediaPackageOutputDestinationSettings.ps1 | 6 +- ...VSMediaLiveChannelNetworkInputSettings.ps1 | 8 +- ...dd-VSMediaLiveChannelOutputDestination.ps1 | 12 +- ...iaLiveChannelOutputDestinationSettings.ps1 | 13 +- ...VSMediaLiveChannelScte20SourceSettings.ps1 | 8 +- ...VSMediaLiveChannelScte27SourceSettings.ps1 | 6 +- ...MediaLiveChannelTeletextSourceSettings.ps1 | 6 +- .../Add-VSMediaLiveChannelVideoSelector.ps1 | 10 +- ...Add-VSMediaLiveChannelVideoSelectorPid.ps1 | 6 +- ...MediaLiveChannelVideoSelectorProgramId.ps1 | 6 +- ...SMediaLiveChannelVideoSelectorSettings.ps1 | 8 +- ...SMediaLiveInputInputDestinationRequest.ps1 | 6 +- ...Add-VSMediaLiveInputInputSourceRequest.ps1 | 10 +- .../Add-VSMediaLiveInputInputVpcRequest.ps1 | 8 +- ...SMediaLiveInputMediaConnectFlowRequest.ps1 | 6 +- ...putSecurityGroupInputWhitelistRuleCidr.ps1 | 6 +- .../Add-VSMediaStoreContainerCorsRule.ps1 | 19 +- .../Add-VSOpsWorksAppDataSource.ps1 | 10 +- .../Add-VSOpsWorksAppEnvironmentVariable.ps1 | 10 +- .../Add-VSOpsWorksAppSource.ps1 | 23 +- .../Add-VSOpsWorksAppSslConfiguration.ps1 | 10 +- .../Add-VSOpsWorksCMServerEngineAttribute.ps1 | 22 +- ...d-VSOpsWorksInstanceBlockDeviceMapping.ps1 | 12 +- .../Add-VSOpsWorksInstanceEbsBlockDevice.ps1 | 15 +- ...VSOpsWorksInstanceTimeBasedAutoScaling.ps1 | 18 +- ...d-VSOpsWorksLayerAutoScalingThresholds.ps1 | 16 +- ...sWorksLayerLifecycleEventConfiguration.ps1 | 6 +- ...dd-VSOpsWorksLayerLoadBasedAutoScaling.ps1 | 10 +- .../Add-VSOpsWorksLayerRecipes.ps1 | 14 +- ...psWorksLayerShutdownEventConfiguration.ps1 | 8 +- ...Add-VSOpsWorksLayerVolumeConfiguration.ps1 | 24 +- .../Add-VSOpsWorksStackChefConfiguration.ps1 | 8 +- .../Add-VSOpsWorksStackElasticIp.ps1 | 8 +- .../Add-VSOpsWorksStackRdsDbInstance.ps1 | 10 +- .../Add-VSOpsWorksStackSource.ps1 | 23 +- ...OpsWorksStackStackConfigurationManager.ps1 | 8 +- ...inpointApplicationSettingsCampaignHook.ps1 | 10 +- ...dd-VSPinpointApplicationSettingsLimits.ps1 | 12 +- ...VSPinpointApplicationSettingsQuietTime.ps1 | 8 +- ...d-VSPinpointCampaignAttributeDimension.ps1 | 8 +- ...VSPinpointCampaignCampaignEmailMessage.ps1 | 12 +- ...-VSPinpointCampaignCampaignEventFilter.ps1 | 8 +- .../Add-VSPinpointCampaignCampaignHook.ps1 | 10 +- ...d-VSPinpointCampaignCampaignSmsMessage.ps1 | 10 +- .../Add-VSPinpointCampaignEventDimensions.ps1 | 10 +- .../Add-VSPinpointCampaignLimits.ps1 | 12 +- .../Add-VSPinpointCampaignMessage.ps1 | 32 +- ...VSPinpointCampaignMessageConfiguration.ps1 | 18 +- .../Add-VSPinpointCampaignMetricDimension.ps1 | 8 +- .../Add-VSPinpointCampaignQuietTime.ps1 | 8 +- .../Add-VSPinpointCampaignSchedule.ps1 | 22 +- .../Add-VSPinpointCampaignSetDimension.ps1 | 8 +- ...PinpointCampaignWriteTreatmentResource.ps1 | 14 +- ...ntEmailConfigurationSetDeliveryOptions.ps1 | 6 +- ...tEventDestinationCloudWatchDestination.ps1 | 6 +- ...EventDestinationDimensionConfiguration.ps1 | 15 +- ...ionSetEventDestinationEventDestination.ps1 | 17 +- ...tDestinationKinesisFirehoseDestination.ps1 | 8 +- ...SetEventDestinationPinpointDestination.ps1 | 6 +- ...ationSetEventDestinationSnsDestination.ps1 | 6 +- ...EmailConfigurationSetReputationOptions.ps1 | 6 +- ...intEmailConfigurationSetSendingOptions.ps1 | 6 +- ...dd-VSPinpointEmailConfigurationSetTags.ps1 | 9 +- ...ntEmailConfigurationSetTrackingOptions.ps1 | 6 +- ...Add-VSPinpointEmailDedicatedIpPoolTags.ps1 | 9 +- ...inpointEmailIdentityMailFromAttributes.ps1 | 9 +- .../Add-VSPinpointEmailIdentityTags.ps1 | 9 +- ...dd-VSPinpointSegmentAttributeDimension.ps1 | 8 +- .../Add-VSPinpointSegmentBehavior.ps1 | 6 +- .../Add-VSPinpointSegmentCoordinates.ps1 | 8 +- .../Add-VSPinpointSegmentDemographic.ps1 | 16 +- .../Add-VSPinpointSegmentGPSPoint.ps1 | 8 +- .../Add-VSPinpointSegmentGroups.ps1 | 13 +- .../Add-VSPinpointSegmentLocation.ps1 | 8 +- .../Add-VSPinpointSegmentRecency.ps1 | 9 +- ...Add-VSPinpointSegmentSegmentDimensions.ps1 | 16 +- .../Add-VSPinpointSegmentSegmentGroups.ps1 | 8 +- .../Add-VSPinpointSegmentSetDimension.ps1 | 8 +- .../Add-VSPinpointSegmentSourceSegments.ps1 | 8 +- .../Add-VSRDSDBClusterDBClusterRole.ps1 | 8 +- ...Add-VSRDSDBClusterScalingConfiguration.ps1 | 17 +- .../Add-VSRDSDBInstanceDBInstanceRole.ps1 | 8 +- .../Add-VSRDSDBInstanceProcessorFeature.ps1 | 8 +- .../Add-VSRDSDBSecurityGroupIngress.ps1 | 12 +- ...dd-VSRDSOptionGroupOptionConfiguration.ps1 | 16 +- .../Add-VSRDSOptionGroupOptionSetting.ps1 | 8 +- ...Add-VSRedshiftClusterLoggingProperties.ps1 | 19 +- ...RedshiftClusterParameterGroupParameter.ps1 | 8 +- ...akerRobotApplicationRobotSoftwareSuite.ps1 | 8 +- ...SRoboMakerRobotApplicationSourceConfig.ps1 | 10 +- ...erSimulationApplicationRenderingEngine.ps1 | 8 +- ...imulationApplicationRobotSoftwareSuite.ps1 | 8 +- ...tionApplicationSimulationSoftwareSuite.ps1 | 8 +- ...MakerSimulationApplicationSourceConfig.ps1 | 10 +- ...dd-VSRoute53HealthCheckAlarmIdentifier.ps1 | 12 +- ...-VSRoute53HealthCheckHealthCheckConfig.ps1 | 86 ++++- ...Add-VSRoute53HealthCheckHealthCheckTag.ps1 | 14 +- ...dd-VSRoute53HostedZoneHostedZoneConfig.ps1 | 6 +- .../Add-VSRoute53HostedZoneHostedZoneTag.ps1 | 14 +- ...-VSRoute53HostedZoneQueryLoggingConfig.ps1 | 6 +- .../Add-VSRoute53HostedZoneVPC.ps1 | 8 +- .../Add-VSRoute53RecordSetAliasTarget.ps1 | 91 +++++- .../Add-VSRoute53RecordSetGeoLocation.ps1 | 12 +- ...Add-VSRoute53RecordSetGroupAliasTarget.ps1 | 91 +++++- ...Add-VSRoute53RecordSetGroupGeoLocation.ps1 | 12 +- .../Add-VSRoute53RecordSetGroupRecordSet.ps1 | 139 +++++++- ...solverResolverEndpointIpAddressRequest.ps1 | 8 +- ...ute53ResolverResolverRuleTargetAddress.ps1 | 8 +- ...S3BucketAbortIncompleteMultipartUpload.ps1 | 6 +- .../Add-VSS3BucketAccelerateConfiguration.ps1 | 6 +- ...Add-VSS3BucketAccessControlTranslation.ps1 | 6 +- .../Add-VSS3BucketAnalyticsConfiguration.ps1 | 13 +- .../Add-VSS3BucketBucketEncryption.ps1 | 6 +- .../Add-VSS3BucketCorsConfiguration.ps1 | 6 +- .../Add-VSS3BucketCorsRule.ps1 | 16 +- .../Add-VSS3BucketDataExport.ps1 | 8 +- .../Add-VSS3BucketDefaultRetention.ps1 | 10 +- .../Add-VSS3BucketDestination.ps1 | 12 +- .../Add-VSS3BucketEncryptionConfiguration.ps1 | 6 +- .../Add-VSS3BucketFilterRule.ps1 | 8 +- .../Add-VSS3BucketInventoryConfiguration.ps1 | 18 +- .../Add-VSS3BucketLambdaConfiguration.ps1 | 10 +- .../Add-VSS3BucketLifecycleConfiguration.ps1 | 6 +- .../Add-VSS3BucketLoggingConfiguration.ps1 | 8 +- .../Add-VSS3BucketMetricsConfiguration.ps1 | 10 +- ...-VSS3BucketNoncurrentVersionTransition.ps1 | 8 +- ...dd-VSS3BucketNotificationConfiguration.ps1 | 16 +- .../Add-VSS3BucketNotificationFilter.ps1 | 6 +- .../Add-VSS3BucketObjectLockConfiguration.ps1 | 8 +- .../Add-VSS3BucketObjectLockRule.ps1 | 6 +- ...S3BucketPublicAccessBlockConfiguration.ps1 | 18 +- .../Add-VSS3BucketQueueConfiguration.ps1 | 10 +- .../Add-VSS3BucketRedirectAllRequestsTo.ps1 | 8 +- .../Add-VSS3BucketRedirectRule.ps1 | 14 +- ...Add-VSS3BucketReplicationConfiguration.ps1 | 8 +- .../Add-VSS3BucketReplicationDestination.ps1 | 17 +- .../Add-VSS3BucketReplicationRule.ps1 | 14 +- .../Add-VSS3BucketRoutingRule.ps1 | 8 +- .../Add-VSS3BucketRoutingRuleCondition.ps1 | 10 +- .../Add-VSS3BucketRule.ps1 | 36 ++- .../Add-VSS3BucketS3KeyFilter.ps1 | 6 +- ...SS3BucketServerSideEncryptionByDefault.ps1 | 8 +- ...Add-VSS3BucketServerSideEncryptionRule.ps1 | 6 +- .../Add-VSS3BucketSourceSelectionCriteria.ps1 | 6 +- .../Add-VSS3BucketSseKmsEncryptedObjects.ps1 | 6 +- .../Add-VSS3BucketStorageClassAnalysis.ps1 | 6 +- .../Add-VSS3BucketTagFilter.ps1 | 8 +- .../Add-VSS3BucketTopicConfiguration.ps1 | 10 +- .../Add-VSS3BucketTransition.ps1 | 10 +- .../Add-VSS3BucketVersioningConfiguration.ps1 | 6 +- .../Add-VSS3BucketWebsiteConfiguration.ps1 | 13 +- ...tEventDestinationCloudWatchDestination.ps1 | 6 +- ...EventDestinationDimensionConfiguration.ps1 | 14 +- ...ionSetEventDestinationEventDestination.ps1 | 20 +- ...tDestinationKinesisFirehoseDestination.ps1 | 8 +- .../Add-VSSESReceiptFilterFilter.ps1 | 11 +- .../Add-VSSESReceiptFilterIpFilter.ps1 | 8 +- .../Add-VSSESReceiptRuleAction.ps1 | 18 +- .../Add-VSSESReceiptRuleAddHeaderAction.ps1 | 8 +- .../Add-VSSESReceiptRuleBounceAction.ps1 | 14 +- .../Add-VSSESReceiptRuleLambdaAction.ps1 | 13 +- .../Add-VSSESReceiptRuleRule.ps1 | 21 +- .../Add-VSSESReceiptRuleS3Action.ps1 | 22 +- .../Add-VSSESReceiptRuleSNSAction.ps1 | 14 +- .../Add-VSSESReceiptRuleStopAction.ps1 | 8 +- .../Add-VSSESReceiptRuleWorkmailAction.ps1 | 8 +- .../Add-VSSESTemplateTemplate.ps1 | 12 +- .../Add-VSSNSTopicSubscription.ps1 | 10 +- ...ationInstanceAssociationOutputLocation.ps1 | 6 +- .../Add-VSSSMAssociationParameterValues.ps1 | 6 +- .../Add-VSSSMAssociationS3OutputLocation.ps1 | 8 +- .../Add-VSSSMAssociationTarget.ps1 | 8 +- ...dd-VSSSMMaintenanceWindowTargetTargets.ps1 | 8 +- ...-VSSSMMaintenanceWindowTaskLoggingInfo.ps1 | 14 +- ...kMaintenanceWindowAutomationParameters.ps1 | 8 +- ...wTaskMaintenanceWindowLambdaParameters.ps1 | 10 +- ...kMaintenanceWindowRunCommandParameters.ps1 | 22 +- ...intenanceWindowStepFunctionsParameters.ps1 | 8 +- ...aintenanceWindowTaskNotificationConfig.ps1 | 12 +- .../Add-VSSSMMaintenanceWindowTaskTarget.ps1 | 8 +- ...anceWindowTaskTaskInvocationParameters.ps1 | 12 +- .../Add-VSSSMPatchBaselinePatchFilter.ps1 | 10 +- ...Add-VSSSMPatchBaselinePatchFilterGroup.ps1 | 6 +- .../Add-VSSSMPatchBaselinePatchSource.ps1 | 14 +- .../Add-VSSSMPatchBaselineRule.ps1 | 12 +- .../Add-VSSSMPatchBaselineRuleGroup.ps1 | 6 +- ...Add-VSSageMakerCodeRepositoryGitConfig.ps1 | 11 +- ...geMakerEndpointConfigProductionVariant.ps1 | 16 +- ...dd-VSSageMakerModelContainerDefinition.ps1 | 17 +- .../Add-VSSageMakerModelVpcConfig.ps1 | 9 +- ...cleConfigNotebookInstanceLifecycleHook.ps1 | 6 +- ...geMakerWorkteamCognitoMemberDefinition.ps1 | 10 +- ...dd-VSSageMakerWorkteamMemberDefinition.ps1 | 6 +- ...MakerWorkteamNotificationConfiguration.ps1 | 6 +- ...tsManagerRotationScheduleRotationRules.ps1 | 7 +- ...cretsManagerSecretGenerateSecretString.ps1 | 28 +- ...nProductProvisioningArtifactProperties.ps1 | 13 +- ...rovisionedProductProvisioningParameter.ps1 | 8 +- ...visionedProductProvisioningPreferences.ps1 | 44 ++- ...Add-VSServiceDiscoveryServiceDnsConfig.ps1 | 22 +- ...Add-VSServiceDiscoveryServiceDnsRecord.ps1 | 39 ++- ...rviceDiscoveryServiceHealthCheckConfig.ps1 | 54 +++- ...iscoveryServiceHealthCheckCustomConfig.ps1 | 39 ++- .../Add-VSStepFunctionsActivityTagsEntry.ps1 | 8 +- ...d-VSStepFunctionsStateMachineTagsEntry.ps1 | 8 +- .../Resource Property Types/Add-VSTag.ps1 | 22 +- .../Add-VSTransferServerEndpointDetails.ps1 | 12 +- ...STransferServerIdentityProviderDetails.ps1 | 8 +- .../Add-VSWAFByteMatchSetByteMatchTuple.ps1 | 72 ++++- .../Add-VSWAFByteMatchSetFieldToMatch.ps1 | 17 +- .../Add-VSWAFIPSetIPSetDescriptor.ps1 | 14 +- ...SWAFRegionalByteMatchSetByteMatchTuple.ps1 | 72 ++++- ...-VSWAFRegionalByteMatchSetFieldToMatch.ps1 | 17 +- ...FRegionalGeoMatchSetGeoMatchConstraint.ps1 | 8 +- .../Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 | 14 +- ...dd-VSWAFRegionalRateBasedRulePredicate.ps1 | 11 +- .../Add-VSWAFRegionalRulePredicate.ps1 | 11 +- ...FRegionalSizeConstraintSetFieldToMatch.ps1 | 17 +- ...egionalSizeConstraintSetSizeConstraint.ps1 | 52 ++- ...gionalSqlInjectionMatchSetFieldToMatch.ps1 | 17 +- ...njectionMatchSetSqlInjectionMatchTuple.ps1 | 39 ++- .../Add-VSWAFRegionalWebACLAction.ps1 | 11 +- .../Add-VSWAFRegionalWebACLRule.ps1 | 14 +- ...d-VSWAFRegionalXssMatchSetFieldToMatch.ps1 | 17 +- ...-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 | 39 ++- .../Add-VSWAFRulePredicate.ps1 | 11 +- ...Add-VSWAFSizeConstraintSetFieldToMatch.ps1 | 17 +- ...d-VSWAFSizeConstraintSetSizeConstraint.ps1 | 52 ++- ...-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 | 17 +- ...njectionMatchSetSqlInjectionMatchTuple.ps1 | 39 ++- .../Add-VSWAFWebACLActivatedRule.ps1 | 15 +- .../Add-VSWAFWebACLWafAction.ps1 | 9 +- .../Add-VSWAFXssMatchSetFieldToMatch.ps1 | 17 +- .../Add-VSWAFXssMatchSetXssMatchTuple.ps1 | 39 ++- .../Add-VSWAFv2RuleGroupAndStatementOne.ps1 | 14 +- .../Add-VSWAFv2RuleGroupAndStatementTwo.ps1 | 14 +- ...Add-VSWAFv2RuleGroupByteMatchStatement.ps1 | 20 +- .../Add-VSWAFv2RuleGroupFieldToMatch.ps1 | 175 +++++++++- .../Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 | 3 +- ...SWAFv2RuleGroupIPSetReferenceStatement.ps1 | 2 +- .../Add-VSWAFv2RuleGroupNotStatementOne.ps1 | 2 +- .../Add-VSWAFv2RuleGroupNotStatementTwo.ps1 | 2 +- .../Add-VSWAFv2RuleGroupOrStatementOne.ps1 | 14 +- .../Add-VSWAFv2RuleGroupOrStatementTwo.ps1 | 14 +- ...-VSWAFv2RuleGroupRateBasedStatementOne.ps1 | 4 +- ...-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 | 4 +- ...GroupRegexPatternSetReferenceStatement.ps1 | 18 +- .../Add-VSWAFv2RuleGroupRule.ps1 | 8 +- .../Add-VSWAFv2RuleGroupRuleAction.ps1 | 75 ++++- ...SWAFv2RuleGroupSizeConstraintStatement.ps1 | 20 +- ...Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 | 16 +- ...Add-VSWAFv2RuleGroupTextTransformation.ps1 | 4 +- .../Add-VSWAFv2RuleGroupVisibilityConfig.ps1 | 6 +- .../Add-VSWAFv2RuleGroupXssMatchStatement.ps1 | 16 +- .../Add-VSWAFv2WebACLAndStatementOne.ps1 | 14 +- .../Add-VSWAFv2WebACLAndStatementTwo.ps1 | 14 +- .../Add-VSWAFv2WebACLByteMatchStatement.ps1 | 20 +- .../Add-VSWAFv2WebACLDefaultAction.ps1 | 50 ++- .../Add-VSWAFv2WebACLExcludedRule.ps1 | 2 +- .../Add-VSWAFv2WebACLFieldToMatch.ps1 | 175 +++++++++- .../Add-VSWAFv2WebACLGeoMatchStatement.ps1 | 3 +- ...d-VSWAFv2WebACLIPSetReferenceStatement.ps1 | 2 +- ...VSWAFv2WebACLManagedRuleGroupStatement.ps1 | 16 +- .../Add-VSWAFv2WebACLNotStatementOne.ps1 | 2 +- .../Add-VSWAFv2WebACLNotStatementTwo.ps1 | 2 +- .../Add-VSWAFv2WebACLOrStatementOne.ps1 | 14 +- .../Add-VSWAFv2WebACLOrStatementTwo.ps1 | 14 +- .../Add-VSWAFv2WebACLOverrideAction.ps1 | 50 ++- ...Add-VSWAFv2WebACLRateBasedStatementOne.ps1 | 4 +- ...Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 | 4 +- ...ebACLRegexPatternSetReferenceStatement.ps1 | 18 +- .../Add-VSWAFv2WebACLRule.ps1 | 8 +- .../Add-VSWAFv2WebACLRuleAction.ps1 | 75 ++++- ...WAFv2WebACLRuleGroupReferenceStatement.ps1 | 14 +- ...d-VSWAFv2WebACLSizeConstraintStatement.ps1 | 20 +- .../Add-VSWAFv2WebACLSqliMatchStatement.ps1 | 16 +- .../Add-VSWAFv2WebACLTextTransformation.ps1 | 4 +- .../Add-VSWAFv2WebACLVisibilityConfig.ps1 | 6 +- .../Add-VSWAFv2WebACLXssMatchStatement.ps1 | 16 +- ...WorkSpacesWorkspaceWorkspaceProperties.ps1 | 14 +- .../Resource Types/New-VSAlexaASKSkill.ps1 | 10 +- .../Resource Types/New-VSAmazonMQBroker.ps1 | 66 +++- .../New-VSAmazonMQConfiguration.ps1 | 16 +- ...New-VSAmazonMQConfigurationAssociation.ps1 | 8 +- .../Resource Types/New-VSAmplifyApp.ps1 | 28 +- .../Resource Types/New-VSAmplifyBranch.ps1 | 26 +- .../Resource Types/New-VSAmplifyDomain.ps1 | 10 +- .../New-VSApiGatewayAccount.ps1 | 12 +- .../Resource Types/New-VSApiGatewayApiKey.ps1 | 21 +- .../New-VSApiGatewayAuthorizer.ps1 | 29 +- .../New-VSApiGatewayBasePathMapping.ps1 | 12 +- .../New-VSApiGatewayClientCertificate.ps1 | 8 +- .../New-VSApiGatewayDeployment.ps1 | 14 +- .../New-VSApiGatewayDocumentationPart.ps1 | 10 +- .../New-VSApiGatewayDocumentationVersion.ps1 | 10 +- .../New-VSApiGatewayDomainName.ps1 | 18 +- .../New-VSApiGatewayGatewayResponse.ps1 | 14 +- .../Resource Types/New-VSApiGatewayMethod.ps1 | 31 +- .../Resource Types/New-VSApiGatewayModel.ps1 | 15 +- .../New-VSApiGatewayRequestValidator.ps1 | 12 +- .../New-VSApiGatewayResource.ps1 | 10 +- .../New-VSApiGatewayRestApi.ps1 | 36 ++- .../Resource Types/New-VSApiGatewayStage.ps1 | 33 +- .../New-VSApiGatewayUsagePlan.ps1 | 16 +- .../New-VSApiGatewayUsagePlanKey.ps1 | 10 +- .../Resource Types/New-VSApiGatewayV2Api.ps1 | 36 ++- .../New-VSApiGatewayV2ApiMapping.ps1 | 12 +- .../New-VSApiGatewayV2Authorizer.ps1 | 23 +- .../New-VSApiGatewayV2Deployment.ps1 | 10 +- .../New-VSApiGatewayV2DomainName.ps1 | 12 +- .../New-VSApiGatewayV2Integration.ps1 | 43 ++- .../New-VSApiGatewayV2IntegrationResponse.ps1 | 21 +- .../New-VSApiGatewayV2Model.ps1 | 14 +- .../New-VSApiGatewayV2Route.ps1 | 28 +- .../New-VSApiGatewayV2RouteResponse.ps1 | 16 +- .../New-VSApiGatewayV2Stage.ps1 | 26 +- .../New-VSApiGatewayVpcLink.ps1 | 10 +- .../Resource Types/New-VSAppMeshMesh.ps1 | 12 +- .../Resource Types/New-VSAppMeshRoute.ps1 | 18 +- .../New-VSAppMeshVirtualNode.ps1 | 22 +- .../New-VSAppMeshVirtualRouter.ps1 | 16 +- .../New-VSAppMeshVirtualService.ps1 | 14 +- .../New-VSAppStreamDirectoryConfig.ps1 | 10 +- .../Resource Types/New-VSAppStreamFleet.ps1 | 62 +++- .../New-VSAppStreamImageBuilder.ps1 | 30 +- .../Resource Types/New-VSAppStreamStack.ps1 | 31 +- .../New-VSAppStreamStackFleetAssociation.ps1 | 10 +- .../New-VSAppStreamStackUserAssociation.ps1 | 13 +- .../Resource Types/New-VSAppStreamUser.ps1 | 16 +- .../Resource Types/New-VSAppSyncApiKey.ps1 | 10 +- .../New-VSAppSyncDataSource.ps1 | 31 +- .../New-VSAppSyncFunctionConfiguration.ps1 | 22 +- .../New-VSAppSyncGraphQLApi.ps1 | 20 +- .../New-VSAppSyncGraphQLSchema.ps1 | 11 +- .../Resource Types/New-VSAppSyncResolver.ps1 | 30 +- ...VSApplicationAutoScalingScalableTarget.ps1 | 27 +- ...-VSApplicationAutoScalingScalingPolicy.ps1 | 27 +- .../Resource Types/New-VSAthenaNamedQuery.ps1 | 12 +- .../New-VSAutoScalingAutoScalingGroup.ps1 | 78 ++++- .../New-VSAutoScalingLaunchConfiguration.ps1 | 65 +++- .../New-VSAutoScalingLifecycleHook.ps1 | 24 +- .../New-VSAutoScalingPlansScalingPlan.ps1 | 20 +- .../New-VSAutoScalingScalingPolicy.ps1 | 39 ++- .../New-VSAutoScalingScheduledAction.ps1 | 30 +- .../Resource Types/New-VSBackupBackupPlan.ps1 | 8 +- .../New-VSBackupBackupSelection.ps1 | 9 +- .../New-VSBackupBackupVault.ps1 | 18 +- .../New-VSBatchComputeEnvironment.ps1 | 16 +- .../New-VSBatchJobDefinition.ps1 | 18 +- .../Resource Types/New-VSBatchJobQueue.ps1 | 12 +- .../Resource Types/New-VSBudgetsBudget.ps1 | 8 +- .../New-VSCertificateManagerCertificate.ps1 | 18 +- .../New-VSCloud9EnvironmentEC2.ps1 | 20 +- .../New-VSCloudFormationCustomResource.ps1 | 14 +- .../New-VSCloudFormationMacro.ps1 | 14 +- .../New-VSCloudFormationStack.ps1 | 31 +- .../New-VSCloudFormationWaitCondition.ps1 | 28 +- ...ew-VSCloudFormationWaitConditionHandle.ps1 | 18 +- ...oudFrontCloudFrontOriginAccessIdentity.ps1 | 6 +- .../New-VSCloudFrontDistribution.ps1 | 8 +- .../New-VSCloudFrontStreamingDistribution.ps1 | 8 +- .../Resource Types/New-VSCloudTrailTrail.ps1 | 44 ++- .../Resource Types/New-VSCloudWatchAlarm.ps1 | 56 +++- .../New-VSCloudWatchAnomalyDetector.ps1 | 14 +- .../New-VSCloudWatchDashboard.ps1 | 11 +- .../Resource Types/New-VSCodeBuildProject.ps1 | 77 ++++- .../New-VSCodeBuildSourceCredential.ps1 | 16 +- .../New-VSCodeCommitRepository.ps1 | 16 +- .../New-VSCodeDeployApplication.ps1 | 9 +- .../New-VSCodeDeployDeploymentConfig.ps1 | 15 +- .../New-VSCodeDeployDeploymentGroup.ps1 | 41 ++- .../New-VSCodePipelineCustomActionType.ps1 | 20 +- .../New-VSCodePipelinePipeline.ps1 | 19 +- .../New-VSCodePipelineWebhook.ps1 | 23 +- .../New-VSCodeStarGitHubRepository.ps1 | 18 +- .../New-VSCognitoIdentityPool.ps1 | 31 +- ...ew-VSCognitoIdentityPoolRoleAttachment.ps1 | 10 +- .../Resource Types/New-VSCognitoUserPool.ps1 | 61 +++- .../New-VSCognitoUserPoolClient.ps1 | 52 ++- .../New-VSCognitoUserPoolGroup.ps1 | 16 +- .../New-VSCognitoUserPoolUser.ps1 | 29 +- ...VSCognitoUserPoolUserToGroupAttachment.ps1 | 10 +- .../New-VSConfigAggregationAuthorization.ps1 | 31 +- .../Resource Types/New-VSConfigConfigRule.ps1 | 35 +- .../New-VSConfigConfigurationAggregator.ps1 | 33 +- .../New-VSConfigConfigurationRecorder.ps1 | 18 +- .../New-VSConfigDeliveryChannel.ps1 | 33 +- .../New-VSConfigOrganizationConfigRule.ps1 | 14 +- .../New-VSConfigRemediationConfiguration.ps1 | 17 +- .../Resource Types/New-VSDAXCluster.ps1 | 38 ++- .../New-VSDAXParameterGroup.ps1 | 10 +- .../Resource Types/New-VSDAXSubnetGroup.ps1 | 10 +- .../New-VSDLMLifecyclePolicy.ps1 | 15 +- .../Resource Types/New-VSDMSCertificate.ps1 | 10 +- .../Resource Types/New-VSDMSEndpoint.ps1 | 40 ++- .../New-VSDMSEventSubscription.ps1 | 20 +- .../New-VSDMSReplicationInstance.ps1 | 45 ++- .../New-VSDMSReplicationSubnetGroup.ps1 | 16 +- .../New-VSDMSReplicationTask.ps1 | 36 ++- .../New-VSDataPipelinePipeline.ps1 | 32 +- .../New-VSDirectoryServiceMicrosoftAD.ps1 | 19 +- .../New-VSDirectoryServiceSimpleAD.ps1 | 21 +- .../Resource Types/New-VSDocDBDBCluster.ps1 | 72 ++++- .../New-VSDocDBDBClusterParameterGroup.ps1 | 25 +- .../Resource Types/New-VSDocDBDBInstance.ps1 | 31 +- .../New-VSDocDBDBSubnetGroup.ps1 | 14 +- .../Resource Types/New-VSDynamoDBTable.ps1 | 47 ++- .../New-VSEC2CapacityReservation.ps1 | 35 +- .../New-VSEC2ClientVpnAuthorizationRule.ps1 | 14 +- .../New-VSEC2ClientVpnEndpoint.ps1 | 30 +- .../New-VSEC2ClientVpnRoute.ps1 | 16 +- ...VSEC2ClientVpnTargetNetworkAssociation.ps1 | 8 +- .../New-VSEC2CustomerGateway.ps1 | 13 +- .../Resource Types/New-VSEC2DHCPOptions.ps1 | 18 +- .../Resource Types/New-VSEC2EC2Fleet.ps1 | 26 +- .../Public/Resource Types/New-VSEC2EIP.ps1 | 21 +- .../New-VSEC2EIPAssociation.ps1 | 21 +- .../New-VSEC2EgressOnlyInternetGateway.ps1 | 6 +- .../Resource Types/New-VSEC2FlowLog.ps1 | 25 +- .../Public/Resource Types/New-VSEC2Host.ps1 | 14 +- .../Resource Types/New-VSEC2Instance.ps1 | 102 +++++- .../New-VSEC2InternetGateway.ps1 | 6 +- .../New-VSEC2LaunchTemplate.ps1 | 8 +- .../Resource Types/New-VSEC2NatGateway.ps1 | 12 +- .../Resource Types/New-VSEC2NetworkAcl.ps1 | 8 +- .../New-VSEC2NetworkAclEntry.ps1 | 23 +- .../New-VSEC2NetworkInterface.ps1 | 27 +- .../New-VSEC2NetworkInterfaceAttachment.ps1 | 12 +- .../New-VSEC2NetworkInterfacePermission.ps1 | 10 +- .../New-VSEC2PlacementGroup.ps1 | 10 +- .../Public/Resource Types/New-VSEC2Route.ps1 | 32 +- .../Resource Types/New-VSEC2RouteTable.ps1 | 10 +- .../Resource Types/New-VSEC2SecurityGroup.ps1 | 28 +- .../New-VSEC2SecurityGroupEgress.ps1 | 37 ++- .../New-VSEC2SecurityGroupIngress.ps1 | 45 ++- .../Resource Types/New-VSEC2SpotFleet.ps1 | 18 +- .../Public/Resource Types/New-VSEC2Subnet.ps1 | 29 +- .../New-VSEC2SubnetCidrBlock.ps1 | 8 +- .../New-VSEC2SubnetNetworkAclAssociation.ps1 | 10 +- .../New-VSEC2SubnetRouteTableAssociation.ps1 | 9 +- .../New-VSEC2TransitGateway.ps1 | 28 +- .../New-VSEC2TransitGatewayAttachment.ps1 | 16 +- .../New-VSEC2TransitGatewayRoute.ps1 | 12 +- .../New-VSEC2TransitGatewayRouteTable.ps1 | 8 +- ...EC2TransitGatewayRouteTableAssociation.ps1 | 8 +- ...EC2TransitGatewayRouteTablePropagation.ps1 | 10 +- .../Public/Resource Types/New-VSEC2VPC.ps1 | 18 +- .../Resource Types/New-VSEC2VPCCidrBlock.ps1 | 12 +- .../New-VSEC2VPCDHCPOptionsAssociation.ps1 | 10 +- .../Resource Types/New-VSEC2VPCEndpoint.ps1 | 27 +- ...VSEC2VPCEndpointConnectionNotification.ps1 | 14 +- .../New-VSEC2VPCEndpointService.ps1 | 10 +- ...New-VSEC2VPCEndpointServicePermissions.ps1 | 10 +- .../New-VSEC2VPCGatewayAttachment.ps1 | 12 +- .../New-VSEC2VPCPeeringConnection.ps1 | 26 +- .../Resource Types/New-VSEC2VPNConnection.ps1 | 23 +- .../New-VSEC2VPNConnectionRoute.ps1 | 10 +- .../Resource Types/New-VSEC2VPNGateway.ps1 | 12 +- .../New-VSEC2VPNGatewayRoutePropagation.ps1 | 10 +- .../Public/Resource Types/New-VSEC2Volume.ps1 | 55 +++- .../New-VSEC2VolumeAttachment.ps1 | 16 +- .../Resource Types/New-VSECRRepository.ps1 | 13 +- .../Resource Types/New-VSECSCluster.ps1 | 6 +- .../Resource Types/New-VSECSService.ps1 | 43 ++- .../New-VSECSTaskDefinition.ps1 | 57 +++- .../Resource Types/New-VSEFSFileSystem.ps1 | 16 +- .../Resource Types/New-VSEFSMountTarget.ps1 | 12 +- .../Resource Types/New-VSEKSCluster.ps1 | 20 +- .../Resource Types/New-VSEMRCluster.ps1 | 42 ++- .../New-VSEMRInstanceFleetConfig.ps1 | 25 +- .../New-VSEMRInstanceGroupConfig.ps1 | 26 +- .../New-VSEMRSecurityConfiguration.ps1 | 8 +- .../Public/Resource Types/New-VSEMRStep.ps1 | 12 +- .../New-VSElastiCacheCacheCluster.ps1 | 107 ++++++- .../New-VSElastiCacheParameterGroup.ps1 | 22 +- .../New-VSElastiCacheReplicationGroup.ps1 | 142 ++++++++- .../New-VSElastiCacheSecurityGroup.ps1 | 12 +- .../New-VSElastiCacheSecurityGroupIngress.ps1 | 14 +- .../New-VSElastiCacheSubnetGroup.ps1 | 12 +- .../New-VSElasticBeanstalkApplication.ps1 | 11 +- ...w-VSElasticBeanstalkApplicationVersion.ps1 | 15 +- ...SElasticBeanstalkConfigurationTemplate.ps1 | 24 +- .../New-VSElasticBeanstalkEnvironment.ps1 | 34 +- ...New-VSElasticLoadBalancingLoadBalancer.ps1 | 50 ++- .../New-VSElasticLoadBalancingV2Listener.ps1 | 16 +- ...sticLoadBalancingV2ListenerCertificate.ps1 | 8 +- ...w-VSElasticLoadBalancingV2ListenerRule.ps1 | 12 +- ...w-VSElasticLoadBalancingV2LoadBalancer.ps1 | 29 +- ...ew-VSElasticLoadBalancingV2TargetGroup.ps1 | 44 ++- .../New-VSElasticsearchDomain.ps1 | 27 +- .../New-VSEventsEventBusPolicy.ps1 | 19 +- .../Resource Types/New-VSEventsRule.ps1 | 24 +- .../Resource Types/New-VSFSxFileSystem.ps1 | 25 +- .../Resource Types/New-VSGameLiftAlias.ps1 | 10 +- .../Resource Types/New-VSGameLiftBuild.ps1 | 12 +- .../Resource Types/New-VSGameLiftFleet.ps1 | 46 ++- .../Resource Types/New-VSGlueClassifier.ps1 | 12 +- .../Resource Types/New-VSGlueConnection.ps1 | 9 +- .../Resource Types/New-VSGlueCrawler.ps1 | 28 +- ...ew-VSGlueDataCatalogEncryptionSettings.ps1 | 8 +- .../Resource Types/New-VSGlueDatabase.ps1 | 9 +- .../Resource Types/New-VSGlueDevEndpoint.ps1 | 34 +- .../Public/Resource Types/New-VSGlueJob.ps1 | 49 ++- .../Resource Types/New-VSGlueMLTransform.ps1 | 40 ++- .../Resource Types/New-VSGluePartition.ps1 | 13 +- .../New-VSGlueSecurityConfiguration.ps1 | 8 +- .../Public/Resource Types/New-VSGlueTable.ps1 | 10 +- .../Resource Types/New-VSGlueTrigger.ps1 | 18 +- .../New-VSGreengrassConnectorDefinition.ps1 | 27 +- ...VSGreengrassConnectorDefinitionVersion.ps1 | 14 +- .../New-VSGreengrassCoreDefinition.ps1 | 27 +- .../New-VSGreengrassCoreDefinitionVersion.ps1 | 14 +- .../New-VSGreengrassDeviceDefinition.ps1 | 27 +- ...ew-VSGreengrassDeviceDefinitionVersion.ps1 | 14 +- .../New-VSGreengrassFunctionDefinition.ps1 | 27 +- ...-VSGreengrassFunctionDefinitionVersion.ps1 | 16 +- .../Resource Types/New-VSGreengrassGroup.ps1 | 41 ++- .../New-VSGreengrassGroupVersion.ps1 | 24 +- .../New-VSGreengrassLoggerDefinition.ps1 | 27 +- ...ew-VSGreengrassLoggerDefinitionVersion.ps1 | 14 +- .../New-VSGreengrassResourceDefinition.ps1 | 27 +- ...-VSGreengrassResourceDefinitionVersion.ps1 | 14 +- ...New-VSGreengrassSubscriptionDefinition.ps1 | 27 +- ...reengrassSubscriptionDefinitionVersion.ps1 | 14 +- .../New-VSGuardDutyDetector.ps1 | 8 +- .../Resource Types/New-VSGuardDutyFilter.ps1 | 16 +- .../Resource Types/New-VSGuardDutyIPSet.ps1 | 14 +- .../Resource Types/New-VSGuardDutyMaster.ps1 | 10 +- .../Resource Types/New-VSGuardDutyMember.ps1 | 16 +- .../New-VSGuardDutyThreatIntelSet.ps1 | 14 +- .../Resource Types/New-VSIAMAccessKey.ps1 | 19 +- .../Public/Resource Types/New-VSIAMGroup.ps1 | 23 +- .../New-VSIAMInstanceProfile.ps1 | 15 +- .../Resource Types/New-VSIAMManagedPolicy.ps1 | 39 ++- .../Public/Resource Types/New-VSIAMPolicy.ps1 | 30 +- .../Public/Resource Types/New-VSIAMRole.ps1 | 35 +- .../New-VSIAMServiceLinkedRole.ps1 | 14 +- .../Public/Resource Types/New-VSIAMUser.ps1 | 31 +- .../New-VSIAMUserToGroupAddition.ps1 | 9 +- .../New-VSInspectorAssessmentTarget.ps1 | 8 +- .../New-VSInspectorAssessmentTemplate.ps1 | 14 +- .../New-VSInspectorResourceGroup.ps1 | 7 +- .../Resource Types/New-VSIoT1ClickDevice.ps1 | 8 +- .../New-VSIoT1ClickPlacement.ps1 | 12 +- .../Resource Types/New-VSIoT1ClickProject.ps1 | 10 +- .../New-VSIoTAnalyticsChannel.ps1 | 13 +- .../New-VSIoTAnalyticsDataset.ps1 | 19 +- .../New-VSIoTAnalyticsDatastore.ps1 | 13 +- .../New-VSIoTAnalyticsPipeline.ps1 | 13 +- .../Resource Types/New-VSIoTCertificate.ps1 | 9 +- .../New-VSIoTEventsDetectorModel.ps1 | 29 +- .../Resource Types/New-VSIoTEventsInput.ps1 | 13 +- .../Public/Resource Types/New-VSIoTPolicy.ps1 | 8 +- .../New-VSIoTPolicyPrincipalAttachment.ps1 | 10 +- .../Public/Resource Types/New-VSIoTThing.ps1 | 10 +- .../New-VSIoTThingPrincipalAttachment.ps1 | 10 +- .../New-VSIoTThingsGraphFlowTemplate.ps1 | 8 +- .../Resource Types/New-VSIoTTopicRule.ps1 | 8 +- .../Public/Resource Types/New-VSKMSAlias.ps1 | 20 +- .../Public/Resource Types/New-VSKMSKey.ps1 | 31 +- .../New-VSKinesisAnalyticsApplication.ps1 | 17 +- ...ew-VSKinesisAnalyticsApplicationOutput.ps1 | 18 +- ...nalyticsApplicationReferenceDataSource.ps1 | 14 +- .../New-VSKinesisAnalyticsV2Application.ps1 | 14 +- ...csV2ApplicationCloudWatchLoggingOption.ps1 | 8 +- ...-VSKinesisAnalyticsV2ApplicationOutput.ps1 | 14 +- ...lyticsV2ApplicationReferenceDataSource.ps1 | 10 +- .../New-VSKinesisFirehoseDeliveryStream.ps1 | 30 +- .../Resource Types/New-VSKinesisStream.ps1 | 15 +- .../New-VSKinesisStreamConsumer.ps1 | 12 +- .../New-VSLakeFormationDataLakeSettings.ps1 | 6 +- .../New-VSLakeFormationPermissions.ps1 | 12 +- .../New-VSLakeFormationResource.ps1 | 10 +- .../Resource Types/New-VSLambdaAlias.ps1 | 21 +- .../New-VSLambdaEventSourceMapping.ps1 | 36 ++- .../Resource Types/New-VSLambdaFunction.ps1 | 37 ++- .../New-VSLambdaLayerVersion.ps1 | 17 +- .../New-VSLambdaLayerVersionPermission.ps1 | 12 +- .../Resource Types/New-VSLambdaPermission.ps1 | 25 +- .../Resource Types/New-VSLambdaVersion.ps1 | 15 +- .../Resource Types/New-VSLogsDestination.ps1 | 12 +- .../Resource Types/New-VSLogsLogGroup.ps1 | 20 +- .../Resource Types/New-VSLogsLogStream.ps1 | 18 +- .../Resource Types/New-VSLogsMetricFilter.ps1 | 12 +- .../New-VSLogsSubscriptionFilter.ps1 | 22 +- .../Resource Types/New-VSMSKCluster.ps1 | 23 +- .../New-VSManagedBlockchainMember.ps1 | 12 +- .../New-VSManagedBlockchainNode.ps1 | 10 +- .../Resource Types/New-VSMediaLiveChannel.ps1 | 24 +- .../Resource Types/New-VSMediaLiveInput.ps1 | 24 +- .../New-VSMediaLiveInputSecurityGroup.ps1 | 10 +- .../New-VSMediaStoreContainer.ps1 | 20 +- .../Resource Types/New-VSNeptuneDBCluster.ps1 | 49 ++- .../New-VSNeptuneDBClusterParameterGroup.ps1 | 20 +- .../New-VSNeptuneDBInstance.ps1 | 58 +++- .../New-VSNeptuneDBParameterGroup.ps1 | 26 +- .../New-VSNeptuneDBSubnetGroup.ps1 | 12 +- .../Resource Types/New-VSOpsWorksApp.ps1 | 32 +- .../Resource Types/New-VSOpsWorksCMServer.ps1 | 63 +++- ...SOpsWorksElasticLoadBalancerAttachment.ps1 | 8 +- .../Resource Types/New-VSOpsWorksInstance.ps1 | 61 +++- .../Resource Types/New-VSOpsWorksLayer.ps1 | 51 ++- .../Resource Types/New-VSOpsWorksStack.ps1 | 100 +++++- .../New-VSOpsWorksUserProfile.ps1 | 12 +- .../Resource Types/New-VSOpsWorksVolume.ps1 | 12 +- .../New-VSPinpointADMChannel.ps1 | 14 +- .../New-VSPinpointAPNSChannel.ps1 | 24 +- .../New-VSPinpointAPNSSandboxChannel.ps1 | 24 +- .../New-VSPinpointAPNSVoipChannel.ps1 | 24 +- .../New-VSPinpointAPNSVoipSandboxChannel.ps1 | 24 +- .../Resource Types/New-VSPinpointApp.ps1 | 10 +- .../New-VSPinpointApplicationSettings.ps1 | 21 +- .../New-VSPinpointBaiduChannel.ps1 | 14 +- .../Resource Types/New-VSPinpointCampaign.ps1 | 34 +- .../New-VSPinpointEmailChannel.ps1 | 16 +- .../New-VSPinpointEmailConfigurationSet.ps1 | 16 +- ...tEmailConfigurationSetEventDestination.ps1 | 12 +- .../New-VSPinpointEmailDedicatedIpPool.ps1 | 8 +- .../New-VSPinpointEmailIdentity.ps1 | 25 +- .../New-VSPinpointEventStream.ps1 | 12 +- .../New-VSPinpointGCMChannel.ps1 | 12 +- .../New-VSPinpointSMSChannel.ps1 | 16 +- .../Resource Types/New-VSPinpointSegment.ps1 | 14 +- .../New-VSPinpointVoiceChannel.ps1 | 8 +- .../Resource Types/New-VSRAMResourceShare.ps1 | 14 +- .../Resource Types/New-VSRDSDBCluster.ps1 | 117 ++++++- .../New-VSRDSDBClusterParameterGroup.ps1 | 16 +- .../Resource Types/New-VSRDSDBInstance.ps1 | 298 +++++++++++++++++- .../New-VSRDSDBParameterGroup.ps1 | 23 +- .../New-VSRDSDBSecurityGroup.ps1 | 19 +- .../New-VSRDSDBSecurityGroupIngress.ps1 | 18 +- .../Resource Types/New-VSRDSDBSubnetGroup.ps1 | 14 +- .../New-VSRDSEventSubscription.ps1 | 21 +- .../Resource Types/New-VSRDSOptionGroup.ps1 | 14 +- .../Resource Types/New-VSRedshiftCluster.ps1 | 125 +++++++- .../New-VSRedshiftClusterParameterGroup.ps1 | 14 +- .../New-VSRedshiftClusterSecurityGroup.ps1 | 10 +- ...-VSRedshiftClusterSecurityGroupIngress.ps1 | 20 +- .../New-VSRedshiftClusterSubnetGroup.ps1 | 12 +- .../Resource Types/New-VSRoboMakerFleet.ps1 | 8 +- .../Resource Types/New-VSRoboMakerRobot.ps1 | 14 +- .../New-VSRoboMakerRobotApplication.ps1 | 14 +- ...New-VSRoboMakerRobotApplicationVersion.ps1 | 8 +- .../New-VSRoboMakerSimulationApplication.ps1 | 18 +- ...SRoboMakerSimulationApplicationVersion.ps1 | 8 +- .../New-VSRoute53HealthCheck.ps1 | 24 +- .../New-VSRoute53HostedZone.ps1 | 74 ++++- .../Resource Types/New-VSRoute53RecordSet.ps1 | 141 ++++++++- .../New-VSRoute53RecordSetGroup.ps1 | 12 +- .../New-VSRoute53ResolverResolverEndpoint.ps1 | 20 +- .../New-VSRoute53ResolverResolverRule.ps1 | 16 +- ...Route53ResolverResolverRuleAssociation.ps1 | 10 +- .../Public/Resource Types/New-VSS3Bucket.ps1 | 50 ++- .../Resource Types/New-VSS3BucketPolicy.ps1 | 8 +- .../Public/Resource Types/New-VSSDBDomain.ps1 | 10 +- .../New-VSSESConfigurationSet.ps1 | 8 +- ...-VSSESConfigurationSetEventDestination.ps1 | 16 +- .../Resource Types/New-VSSESReceiptFilter.ps1 | 6 +- .../Resource Types/New-VSSESReceiptRule.ps1 | 14 +- .../New-VSSESReceiptRuleSet.ps1 | 10 +- .../Resource Types/New-VSSESTemplate.ps1 | 8 +- .../Resource Types/New-VSSNSSubscription.ps1 | 22 +- .../Public/Resource Types/New-VSSNSTopic.ps1 | 23 +- .../Resource Types/New-VSSNSTopicPolicy.ps1 | 8 +- .../Public/Resource Types/New-VSSQSQueue.ps1 | 60 +++- .../Resource Types/New-VSSQSQueuePolicy.ps1 | 8 +- .../Resource Types/New-VSSSMAssociation.ps1 | 22 +- .../Resource Types/New-VSSSMDocument.ps1 | 12 +- .../New-VSSSMMaintenanceWindow.ps1 | 26 +- .../New-VSSSMMaintenanceWindowTarget.ps1 | 24 +- .../New-VSSSMMaintenanceWindowTask.ps1 | 37 ++- .../Resource Types/New-VSSSMParameter.ps1 | 31 +- .../Resource Types/New-VSSSMPatchBaseline.ps1 | 36 ++- .../New-VSSSMResourceDataSync.ps1 | 24 +- .../New-VSSageMakerCodeRepository.ps1 | 10 +- .../New-VSSageMakerEndpoint.ps1 | 11 +- .../New-VSSageMakerEndpointConfig.ps1 | 13 +- .../Resource Types/New-VSSageMakerModel.ps1 | 18 +- .../New-VSSageMakerNotebookInstance.ps1 | 37 ++- ...geMakerNotebookInstanceLifecycleConfig.ps1 | 10 +- .../New-VSSageMakerWorkteam.ps1 | 17 +- .../New-VSSecretsManagerResourcePolicy.ps1 | 9 +- .../New-VSSecretsManagerRotationSchedule.ps1 | 14 +- .../New-VSSecretsManagerSecret.ps1 | 39 ++- ...VSSecretsManagerSecretTargetAttachment.ps1 | 16 +- .../Resource Types/New-VSSecurityHubHub.ps1 | 6 +- ...VSServiceCatalogAcceptedPortfolioShare.ps1 | 11 +- ...-VSServiceCatalogCloudFormationProduct.ps1 | 27 +- ...atalogCloudFormationProvisionedProduct.ps1 | 39 ++- ...iceCatalogLaunchNotificationConstraint.ps1 | 17 +- ...w-VSServiceCatalogLaunchRoleConstraint.ps1 | 17 +- ...ServiceCatalogLaunchTemplateConstraint.ps1 | 17 +- .../New-VSServiceCatalogPortfolio.ps1 | 17 +- ...ceCatalogPortfolioPrincipalAssociation.ps1 | 15 +- ...viceCatalogPortfolioProductAssociation.ps1 | 15 +- .../New-VSServiceCatalogPortfolioShare.ps1 | 13 +- ...ServiceCatalogResourceUpdateConstraint.ps1 | 18 +- ...New-VSServiceCatalogStackSetConstraint.ps1 | 28 +- .../New-VSServiceCatalogTagOption.ps1 | 10 +- ...w-VSServiceCatalogTagOptionAssociation.ps1 | 8 +- .../New-VSServiceDiscoveryHttpNamespace.ps1 | 10 +- .../New-VSServiceDiscoveryInstance.ps1 | 41 ++- ...-VSServiceDiscoveryPrivateDnsNamespace.ps1 | 10 +- ...w-VSServiceDiscoveryPublicDnsNamespace.ps1 | 8 +- .../New-VSServiceDiscoveryService.ps1 | 32 +- .../New-VSStepFunctionsActivity.ps1 | 17 +- .../New-VSStepFunctionsStateMachine.ps1 | 19 +- .../Resource Types/New-VSTransferServer.ps1 | 16 +- .../Resource Types/New-VSTransferUser.ps1 | 25 +- .../Resource Types/New-VSWAFByteMatchSet.ps1 | 8 +- .../Public/Resource Types/New-VSWAFIPSet.ps1 | 10 +- .../New-VSWAFRegionalByteMatchSet.ps1 | 8 +- .../New-VSWAFRegionalGeoMatchSet.ps1 | 8 +- .../Resource Types/New-VSWAFRegionalIPSet.ps1 | 10 +- .../New-VSWAFRegionalRateBasedRule.ps1 | 22 +- .../New-VSWAFRegionalRegexPatternSet.ps1 | 8 +- .../Resource Types/New-VSWAFRegionalRule.ps1 | 16 +- .../New-VSWAFRegionalSizeConstraintSet.ps1 | 8 +- .../New-VSWAFRegionalSqlInjectionMatchSet.ps1 | 8 +- .../New-VSWAFRegionalWebACL.ps1 | 12 +- .../New-VSWAFRegionalWebACLAssociation.ps1 | 8 +- .../New-VSWAFRegionalXssMatchSet.ps1 | 8 +- .../Public/Resource Types/New-VSWAFRule.ps1 | 16 +- .../New-VSWAFSizeConstraintSet.ps1 | 8 +- .../New-VSWAFSqlInjectionMatchSet.ps1 | 8 +- .../Public/Resource Types/New-VSWAFWebACL.ps1 | 12 +- .../Resource Types/New-VSWAFXssMatchSet.ps1 | 8 +- .../Resource Types/New-VSWAFv2IPSet.ps1 | 27 +- .../New-VSWAFv2RegexPatternSet.ps1 | 27 +- .../Resource Types/New-VSWAFv2RuleGroup.ps1 | 36 ++- .../Resource Types/New-VSWAFv2WebACL.ps1 | 36 ++- .../New-VSWorkSpacesWorkspace.ps1 | 22 +- VaporShell/VaporShell.psd1 | 2 +- 1574 files changed, 22031 insertions(+), 2867 deletions(-) create mode 100644 VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 diff --git a/VaporShell/Private/ProcessRequest3.ps1 b/VaporShell/Private/ProcessRequest3.ps1 index 29099e304..6f3375d59 100644 --- a/VaporShell/Private/ProcessRequest3.ps1 +++ b/VaporShell/Private/ProcessRequest3.ps1 @@ -30,18 +30,50 @@ function ProcessRequest3 { try { $service = ($request.PSObject.TypeNames)[0].split('.')[1] $sharedFile = New-Object Amazon.Runtime.CredentialManagement.SharedCredentialsFile -ErrorAction Stop - $endPoint = ($sharedFile.ListProfiles() | Where-Object {$_.Name -eq $ProfileName}).Region - $storedCreds = New-Object Amazon.Runtime.StoredProfileAWSCredentials $ProfileName -ErrorAction Stop + $matchedProfile = $sharedFile.ListProfiles() | Where-Object {$_.Name -eq $ProfileName} + if ($null -eq $matchedProfile) { + $creds = [Amazon.Runtime.FallbackCredentialsFactory]::GetCredentials() + $endPoint = if ([Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint()) { + [Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint() + } + else { + # Need to set a default if we can't resolve the region + Write-Warning "Unable to resolve target region! Defaulting to us-east-1 and continuing in 5 seconds." + Write-Warning "If you do not want to execute method [$Method] on service [$service] in this region," + Write-Warning "please set the environment variable 'AWS_REGION' or run the following to set a region" + Write-Warning "on the shared credential file:`n`n`tSet-VSCredential -ProfileName $ProfileName -Region " + Start-Sleep -Seconds 5 + [Amazon.RegionEndpoint]::USEast1 + } + } + else { + $creds = New-Object Amazon.Runtime.StoredProfileAWSCredentials $ProfileName -ErrorAction Stop + $endPoint = if ($matchedProfile.Region) { + $matchedProfile.Region + } + elseif ([Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint()) { + [Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint() + } + else { + # Need to set a default if we can't resolve the region + Write-Warning "Unable to resolve target region! Defaulting to us-east-1 and continuing in 5 seconds." + Write-Warning "If you do not want to execute method [$Method] on service [$service] in this region," + Write-Warning "please set the environment variable 'AWS_REGION' or run the following to set a region" + Write-Warning "on the shared credential file:`n`n`tSet-VSCredential -ProfileName $ProfileName -Region " + Start-Sleep -Seconds 5 + [Amazon.RegionEndpoint]::USEast1 + } + } Write-Verbose "Building '$service' client in region '$($endPoint.DisplayName)' [$($endPoint.SystemName)]" if ($endPoint) { - $client = New-Object "Amazon.$($service).Amazon$($service)Client" $storedCreds,$endPoint -ErrorAction Stop + $client = New-Object "Amazon.$($service).Amazon$($service)Client" $creds,$endPoint -ErrorAction Stop } else { return (New-VSError -String "No region set for profile '$ProfileName'! Please run the following to set a region:`n`nSet-VSCredential -ProfileName $ProfileName -Region ") } } catch { - return (New-VSError -String "$($Error[0].Exception.Message)") + return (New-VSError -String "$($_.Exception.Message)") } Write-Verbose "Processing request:`n$($PSBoundParameters | Format-Table -AutoSize | Out-String)" $i = 0 @@ -81,4 +113,4 @@ function ProcessRequest3 { return $result } } -} \ No newline at end of file +} diff --git a/VaporShell/Private/ProcessRequest4.ps1 b/VaporShell/Private/ProcessRequest4.ps1 index 882efa4cd..2ec43c18c 100644 --- a/VaporShell/Private/ProcessRequest4.ps1 +++ b/VaporShell/Private/ProcessRequest4.ps1 @@ -30,18 +30,50 @@ function ProcessRequest4 { try { $service = ($request.PSObject.TypeNames)[0].split('.')[1] $sharedFile = New-Object Amazon.Runtime.CredentialManagement.SharedCredentialsFile -ErrorAction Stop - $endPoint = ($sharedFile.ListProfiles() | Where-Object {$_.Name -eq $ProfileName}).Region - $storedCreds = New-Object Amazon.Runtime.StoredProfileAWSCredentials $ProfileName -ErrorAction Stop + $matchedProfile = $sharedFile.ListProfiles() | Where-Object {$_.Name -eq $ProfileName} + if ($null -eq $matchedProfile) { + $creds = [Amazon.Runtime.FallbackCredentialsFactory]::GetCredentials() + $endPoint = if ([Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint()) { + [Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint() + } + else { + # Need to set a default if we can't resolve the region + Write-Warning "Unable to resolve target region! Defaulting to us-east-1 and continuing in 5 seconds." + Write-Warning "If you do not want to execute method [$Method] on service [$service] in this region," + Write-Warning "please set the environment variable 'AWS_REGION' or run the following to set a region" + Write-Warning "on the shared credential file:`n`n`tSet-VSCredential -ProfileName $ProfileName -Region " + Start-Sleep -Seconds 5 + [Amazon.RegionEndpoint]::USEast1 + } + } + else { + $creds = New-Object Amazon.Runtime.StoredProfileAWSCredentials $ProfileName -ErrorAction Stop + $endPoint = if ($matchedProfile.Region) { + $matchedProfile.Region + } + elseif ([Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint()) { + [Amazon.Runtime.FallbackRegionFactory]::GetRegionEndpoint() + } + else { + # Need to set a default if we can't resolve the region + Write-Warning "Unable to resolve target region! Defaulting to us-east-1 and continuing in 5 seconds." + Write-Warning "If you do not want to execute method [$Method] on service [$service] in this region," + Write-Warning "please set the environment variable 'AWS_REGION' or run the following to set a region" + Write-Warning "on the shared credential file:`n`n`tSet-VSCredential -ProfileName $ProfileName -Region " + Start-Sleep -Seconds 5 + [Amazon.RegionEndpoint]::USEast1 + } + } Write-Verbose "Building '$service' client in region '$($endPoint.DisplayName)' [$($endPoint.SystemName)]" if ($endPoint) { - $client = New-Object "Amazon.$($service).Amazon$($service)Client" $storedCreds,$endPoint -ErrorAction Stop + $client = New-Object "Amazon.$($service).Amazon$($service)Client" $creds,$endPoint -ErrorAction Stop } else { return (New-VSError -String "No region set for profile '$ProfileName'! Please run the following to set a region:`n`nSet-VSCredential -ProfileName $ProfileName -Region ") } } catch { - return (New-VSError -String "$($Error[0].Exception.Message)") + return (New-VSError -String "$($_.Exception.Message)") } if ($client | Get-Member -MemberType Method -Name "$Method*" | Where-Object {$_.Name -eq "$($Method)Async"}) { $useAsync = $true diff --git a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 index 0449bcef1..2b9fbc0ce 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 @@ -1,26 +1,34 @@ function Add-VSAlexaASKSkillAuthenticationConfiguration { <# .SYNOPSIS - Adds an Alexa::ASK::Skill.AuthenticationConfiguration resource property to the template. + Adds an Alexa::ASK::Skill.AuthenticationConfiguration resource property to the template. The AuthenticationConfiguration property type specifies the Login with Amazon (LWA configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the Amazon Developer Console: https://developer.amazon.com/lwa/sp/overview.html are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new security profile: https://developer.amazon.com/lwa/sp/create-security-profile.html on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then produce the refresh token by providing the client ID and client secret to the generate-lwa-tokens: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#generate-lwa-tokens command in the ASK CLI: https://developer.amazon.com/docs/smapi/ask-cli-intro.html. .DESCRIPTION Adds an Alexa::ASK::Skill.AuthenticationConfiguration resource property to the template. +The AuthenticationConfiguration property type specifies the Login with Amazon (LWA configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the Amazon Developer Console: https://developer.amazon.com/lwa/sp/overview.html are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new security profile: https://developer.amazon.com/lwa/sp/create-security-profile.html on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then produce the refresh token by providing the client ID and client secret to the generate-lwa-tokens: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#generate-lwa-tokens command in the ASK CLI: https://developer.amazon.com/docs/smapi/ask-cli-intro.html. +AuthenticationConfiguration is a property of the Alexa::ASK::Skill resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html .PARAMETER RefreshToken + Refresh token from Login with Amazon LWA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-refreshtoken PrimitiveType: String UpdateType: Mutable .PARAMETER ClientSecret + Client secret from Login with Amazon LWA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientsecret PrimitiveType: String UpdateType: Mutable .PARAMETER ClientId + Client ID from Login with Amazon LWA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillOverrides.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillOverrides.ps1 index d80a76ed7..e06bcba8c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillOverrides.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillOverrides.ps1 @@ -1,16 +1,20 @@ function Add-VSAlexaASKSkillOverrides { <# .SYNOPSIS - Adds an Alexa::ASK::Skill.Overrides resource property to the template. + Adds an Alexa::ASK::Skill.Overrides resource property to the template. The Overrides property type provides overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported. .DESCRIPTION Adds an Alexa::ASK::Skill.Overrides resource property to the template. +The Overrides property type provides overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported. +Overrides is a property of the Alexa::ASK::Skill SkillPackage property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html .PARAMETER Manifest + Overrides to apply to the skill manifest inside of the skill package. The skill manifest contains metadata about the skill. For more information, see Skill Manifest Schemas: https://developer.amazon.com/docs/smapi/skill-manifest.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html#cfn-ask-skill-overrides-manifest PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 index fc9e15524..ea6ec99a6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 @@ -1,36 +1,48 @@ function Add-VSAlexaASKSkillSkillPackage { <# .SYNOPSIS - Adds an Alexa::ASK::Skill.SkillPackage resource property to the template. + Adds an Alexa::ASK::Skill.SkillPackage resource property to the template. The SkillPackage property type contains configuration details for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. More details about the skill package format are located in the Skill Package API Reference: https://developer.amazon.com/docs/smapi/skill-package-api-reference.html#skill-package-format. .DESCRIPTION Adds an Alexa::ASK::Skill.SkillPackage resource property to the template. +The SkillPackage property type contains configuration details for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. More details about the skill package format are located in the Skill Package API Reference: https://developer.amazon.com/docs/smapi/skill-package-api-reference.html#skill-package-format. +SkillPackage is a property of the Alexa::ASK::Skill resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html .PARAMETER S3BucketRole + ARN of the role that grants the Alexa service permission to access the bucket and retrieve the skill package. This role is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, AWS CloudFormation cannot create the skill. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucketrole PrimitiveType: String UpdateType: Mutable .PARAMETER S3ObjectVersion + If you have S3 versioning enabled, the version ID of the skill package.zip file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3objectversion PrimitiveType: String UpdateType: Mutable .PARAMETER S3Bucket + The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucket PrimitiveType: String UpdateType: Mutable .PARAMETER S3Key + The location and name of the skill package .zip file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3key PrimitiveType: String UpdateType: Mutable .PARAMETER Overrides + Overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported. + Type: Overrides Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-overrides UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerConfigurationId.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerConfigurationId.ps1 index df77039d0..fb8c407f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerConfigurationId.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerConfigurationId.ps1 @@ -1,21 +1,25 @@ function Add-VSAmazonMQBrokerConfigurationId { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker.ConfigurationId resource property to the template. + Adds an AWS::AmazonMQ::Broker.ConfigurationId resource property to the template. A list of information about the configuration. .DESCRIPTION Adds an AWS::AmazonMQ::Broker.ConfigurationId resource property to the template. - +A list of information about the configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html .PARAMETER Revision + The revision number of the configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-revision PrimitiveType: Integer UpdateType: Mutable .PARAMETER Id + The unique ID that Amazon MQ generates for the configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-id PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerEncryptionOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerEncryptionOptions.ps1 index 6281ad4ad..b048d23a3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerEncryptionOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerEncryptionOptions.ps1 @@ -1,21 +1,25 @@ function Add-VSAmazonMQBrokerEncryptionOptions { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker.EncryptionOptions resource property to the template. + Adds an AWS::AmazonMQ::Broker.EncryptionOptions resource property to the template. Encryption options for the broker. .DESCRIPTION Adds an AWS::AmazonMQ::Broker.EncryptionOptions resource property to the template. - +Encryption options for the broker. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html .PARAMETER KmsKeyId + The customer master key CMK to use for the AWS Key Management Service KMS. This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-kmskeyid PrimitiveType: String UpdateType: Mutable .PARAMETER UseAwsOwnedKey + Enables the use of an AWS owned CMK using AWS Key Management Service KMS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-useawsownedkey PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerLogList.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerLogList.ps1 index 940b834e6..aadfcb6ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerLogList.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerLogList.ps1 @@ -1,21 +1,25 @@ function Add-VSAmazonMQBrokerLogList { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker.LogList resource property to the template. + Adds an AWS::AmazonMQ::Broker.LogList resource property to the template. The list of information about logs to be enabled for the specified broker. .DESCRIPTION Adds an AWS::AmazonMQ::Broker.LogList resource property to the template. - +The list of information about logs to be enabled for the specified broker. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html .PARAMETER Audit + Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-audit PrimitiveType: Boolean UpdateType: Mutable .PARAMETER General + Enables general logging. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-general PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerMaintenanceWindow.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerMaintenanceWindow.ps1 index 44e93f379..ae83b9f06 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerMaintenanceWindow.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerMaintenanceWindow.ps1 @@ -1,26 +1,32 @@ function Add-VSAmazonMQBrokerMaintenanceWindow { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker.MaintenanceWindow resource property to the template. + Adds an AWS::AmazonMQ::Broker.MaintenanceWindow resource property to the template. The parameters that determine the WeeklyStartTime to apply pending updates or patches to the broker. .DESCRIPTION Adds an AWS::AmazonMQ::Broker.MaintenanceWindow resource property to the template. - +The parameters that determine the WeeklyStartTime to apply pending updates or patches to the broker. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html .PARAMETER DayOfWeek + The day of the week. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-dayofweek PrimitiveType: String UpdateType: Mutable .PARAMETER TimeOfDay + The time, in 24-hour format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timeofday PrimitiveType: String UpdateType: Mutable .PARAMETER TimeZone + The time zone, UTC by default, in either the Country/City format, or the UTC offset format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timezone PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerTagsEntry.ps1 index 9e4a7dc8e..31d0a8b31 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSAmazonMQBrokerTagsEntry { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker.TagsEntry resource property to the template. + Adds an AWS::AmazonMQ::Broker.TagsEntry resource property to the template. A key-value pair to associate with the broker. .DESCRIPTION Adds an AWS::AmazonMQ::Broker.TagsEntry resource property to the template. - +A key-value pair to associate with the broker. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html .PARAMETER Value + The value in a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key in a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerUser.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerUser.ps1 index 7401bac8d..2fc8769d8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerUser.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQBrokerUser.ps1 @@ -1,32 +1,40 @@ function Add-VSAmazonMQBrokerUser { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker.User resource property to the template. + Adds an AWS::AmazonMQ::Broker.User resource property to the template. The list of ActiveMQ users (persons or applications who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~. This value must be 2-100 characters long. .DESCRIPTION Adds an AWS::AmazonMQ::Broker.User resource property to the template. - +The list of ActiveMQ users (persons or applications who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~. This value must be 2-100 characters long. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html .PARAMETER Username + The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes - . _ ~. This value must be 2-100 characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username PrimitiveType: String UpdateType: Mutable .PARAMETER Groups + The list of groups 20 maximum to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes - . _ ~. This value must be 2-100 characters long. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups UpdateType: Mutable .PARAMETER ConsoleAccess + Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Password + The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationAssociationConfigurationId.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationAssociationConfigurationId.ps1 index 9b35403be..3f8c0fe88 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationAssociationConfigurationId.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationAssociationConfigurationId.ps1 @@ -1,21 +1,25 @@ function Add-VSAmazonMQConfigurationAssociationConfigurationId { <# .SYNOPSIS - Adds an AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId resource property to the template. + Adds an AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId resource property to the template. The ConfigurationId property type specifies a configuration Id and the revision of a configuration. .DESCRIPTION Adds an AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId resource property to the template. - +The ConfigurationId property type specifies a configuration Id and the revision of a configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html .PARAMETER Revision + The revision number of the configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-revision PrimitiveType: Integer UpdateType: Mutable .PARAMETER Id + The unique ID that Amazon MQ generates for the configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-id PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationTagsEntry.ps1 index 7dc632f81..c1f51dcda 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmazonMQConfigurationTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSAmazonMQConfigurationTagsEntry { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Configuration.TagsEntry resource property to the template. + Adds an AWS::AmazonMQ::Configuration.TagsEntry resource property to the template. A key-value pair to associate with the configuration. .DESCRIPTION Adds an AWS::AmazonMQ::Configuration.TagsEntry resource property to the template. - +A key-value pair to associate with the configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html .PARAMETER Value + The value in a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key in a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 index d5d9f21c5..377ae2fb0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 @@ -1,58 +1,76 @@ function Add-VSAmplifyAppAutoBranchCreationConfig { <# .SYNOPSIS - Adds an AWS::Amplify::App.AutoBranchCreationConfig resource property to the template. + Adds an AWS::Amplify::App.AutoBranchCreationConfig resource property to the template. Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern. .DESCRIPTION Adds an AWS::Amplify::App.AutoBranchCreationConfig resource property to the template. - +Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html .PARAMETER EnvironmentVariables + Environment variables for the auto created branch. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-environmentvariables ItemType: EnvironmentVariable UpdateType: Mutable .PARAMETER EnableAutoBranchCreation + Enables automated branch creation for the Amplify app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobranchcreation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PullRequestEnvironmentName + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-pullrequestenvironmentname PrimitiveType: String UpdateType: Mutable .PARAMETER AutoBranchCreationPatterns + Automated branch creation glob patterns for the Amplify app. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-autobranchcreationpatterns UpdateType: Mutable .PARAMETER EnablePullRequestPreview + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enablepullrequestpreview PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EnableAutoBuild + Enables auto building for the auto created branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobuild PrimitiveType: Boolean UpdateType: Mutable .PARAMETER BuildSpec + Build spec for the auto created branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-buildspec PrimitiveType: String UpdateType: Mutable .PARAMETER Stage + Stage for the auto created branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-stage PrimitiveType: String UpdateType: Mutable .PARAMETER BasicAuthConfig + Sets password protection for your auto created branch. + Type: BasicAuthConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-basicauthconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppBasicAuthConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppBasicAuthConfig.ps1 index d7d043910..8907a32a9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppBasicAuthConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppBasicAuthConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSAmplifyAppBasicAuthConfig { <# .SYNOPSIS - Adds an AWS::Amplify::App.BasicAuthConfig resource property to the template. + Adds an AWS::Amplify::App.BasicAuthConfig resource property to the template. Use the BasicAuthConfig property type to set password protection at an app level to all your branches. .DESCRIPTION Adds an AWS::Amplify::App.BasicAuthConfig resource property to the template. - +Use the BasicAuthConfig property type to set password protection at an app level to all your branches. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html .PARAMETER Username + The user name for basic authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-username PrimitiveType: String UpdateType: Mutable .PARAMETER EnableBasicAuth + Enables Basic Authorization for branches for the Amplify App. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-enablebasicauth PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Password + The password for basic authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-password PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppCustomRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppCustomRule.ps1 index fe62eeff8..59cd97b75 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppCustomRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppCustomRule.ps1 @@ -1,31 +1,39 @@ function Add-VSAmplifyAppCustomRule { <# .SYNOPSIS - Adds an AWS::Amplify::App.CustomRule resource property to the template. + Adds an AWS::Amplify::App.CustomRule resource property to the template. The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies. Redirects enable a web app to reroute navigation from one URL to another. .DESCRIPTION Adds an AWS::Amplify::App.CustomRule resource property to the template. - +The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies. Redirects enable a web app to reroute navigation from one URL to another. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html .PARAMETER Condition + The condition for a URL rewrite or redirect rule, e.g. country code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-condition PrimitiveType: String UpdateType: Mutable .PARAMETER Status + The status code for a URL rewrite or redirect rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-status PrimitiveType: String UpdateType: Mutable .PARAMETER Target + The target pattern for a URL rewrite or redirect rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-target PrimitiveType: String UpdateType: Mutable .PARAMETER Source + The source pattern for a URL rewrite or redirect rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-source PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppEnvironmentVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppEnvironmentVariable.ps1 index 315c0eafe..a88ca8b80 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppEnvironmentVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppEnvironmentVariable.ps1 @@ -1,21 +1,25 @@ function Add-VSAmplifyAppEnvironmentVariable { <# .SYNOPSIS - Adds an AWS::Amplify::App.EnvironmentVariable resource property to the template. + Adds an AWS::Amplify::App.EnvironmentVariable resource property to the template. Environment variables are key-value pairs that are available at build time. Set environment variables for all branches in your app. .DESCRIPTION Adds an AWS::Amplify::App.EnvironmentVariable resource property to the template. - +Environment variables are key-value pairs that are available at build time. Set environment variables for all branches in your app. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html .PARAMETER Value + The environment variable value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The environment variable name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchBasicAuthConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchBasicAuthConfig.ps1 index d3181acde..243884a22 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchBasicAuthConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchBasicAuthConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSAmplifyBranchBasicAuthConfig { <# .SYNOPSIS - Adds an AWS::Amplify::Branch.BasicAuthConfig resource property to the template. + Adds an AWS::Amplify::Branch.BasicAuthConfig resource property to the template. Use the BasicAuthConfig property type to set password protection for a specific branch. .DESCRIPTION Adds an AWS::Amplify::Branch.BasicAuthConfig resource property to the template. - +Use the BasicAuthConfig property type to set password protection for a specific branch. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html .PARAMETER Username + The user name for basic authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-username PrimitiveType: String UpdateType: Mutable .PARAMETER EnableBasicAuth + Enables Basic Auth for the branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-enablebasicauth PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Password + The password for basic authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-password PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchEnvironmentVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchEnvironmentVariable.ps1 index 4c628bd0e..440ee6921 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchEnvironmentVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyBranchEnvironmentVariable.ps1 @@ -1,21 +1,25 @@ function Add-VSAmplifyBranchEnvironmentVariable { <# .SYNOPSIS - Adds an AWS::Amplify::Branch.EnvironmentVariable resource property to the template. + Adds an AWS::Amplify::Branch.EnvironmentVariable resource property to the template. The EnvironmentVariable property type sets environment variables for a specific branch. Environment variables are key-value pairs that are available at build time. .DESCRIPTION Adds an AWS::Amplify::Branch.EnvironmentVariable resource property to the template. - +The EnvironmentVariable property type sets environment variables for a specific branch. Environment variables are key-value pairs that are available at build time. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html .PARAMETER Value + The environment variable value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The environment variable name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyDomainSubDomainSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyDomainSubDomainSetting.ps1 index e922ee94b..894aa72a7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyDomainSubDomainSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyDomainSubDomainSetting.ps1 @@ -1,21 +1,25 @@ function Add-VSAmplifyDomainSubDomainSetting { <# .SYNOPSIS - Adds an AWS::Amplify::Domain.SubDomainSetting resource property to the template. + Adds an AWS::Amplify::Domain.SubDomainSetting resource property to the template. The SubDomainSetting property type allows you to connect a subdomain (e.g. foo.yourdomain.com to a specific branch. .DESCRIPTION Adds an AWS::Amplify::Domain.SubDomainSetting resource property to the template. - +The SubDomainSetting property type allows you to connect a subdomain (e.g. foo.yourdomain.com to a specific branch. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html .PARAMETER Prefix + Prefix setting for the Subdomain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER BranchName + Branch name setting for the Subdomain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-branchname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayApiKeyStageKey.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayApiKeyStageKey.ps1 index d3c5a9e8e..7cd2ec096 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayApiKeyStageKey.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayApiKeyStageKey.ps1 @@ -1,21 +1,25 @@ function Add-VSApiGatewayApiKeyStageKey { <# .SYNOPSIS - Adds an AWS::ApiGateway::ApiKey.StageKey resource property to the template. + Adds an AWS::ApiGateway::ApiKey.StageKey resource property to the template. StageKey is a property of the AWS::ApiGateway::ApiKey: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage. .DESCRIPTION Adds an AWS::ApiGateway::ApiKey.StageKey resource property to the template. - +StageKey is a property of the AWS::ApiGateway::ApiKey: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html .PARAMETER RestApiId + The ID of a RestApi resource that includes the stage with which you want to associate the API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid PrimitiveType: String UpdateType: Mutable .PARAMETER StageName + The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 index d00bdcb1b..61eefc07d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 @@ -1,21 +1,27 @@ function Add-VSApiGatewayDeploymentAccessLogSetting { <# .SYNOPSIS - Adds an AWS::ApiGateway::Deployment.AccessLogSetting resource property to the template. + Adds an AWS::ApiGateway::Deployment.AccessLogSetting resource property to the template. The AccessLogSetting property type specifies settings for logging access in this stage. .DESCRIPTION Adds an AWS::ApiGateway::Deployment.AccessLogSetting resource property to the template. +The AccessLogSetting property type specifies settings for logging access in this stage. +AccessLogSetting is a property of the StageDescription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html .PARAMETER DestinationArn + The Amazon Resource Name ARN of the CloudWatch Logs log group to receive access logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn PrimitiveType: String UpdateType: Mutable .PARAMETER Format + A single line format of the access logs of data, as specified by selected $context variables: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference. The format must include at least $context.requestId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentCanarySetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentCanarySetting.ps1 index 4ad9506fe..12d310ba9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentCanarySetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentCanarySetting.ps1 @@ -1,21 +1,27 @@ function Add-VSApiGatewayDeploymentCanarySetting { <# .SYNOPSIS - Adds an AWS::ApiGateway::Deployment.CanarySetting resource property to the template. + Adds an AWS::ApiGateway::Deployment.CanarySetting resource property to the template. The CanarySetting property type specifies settings for the canary deployment in this stage. .DESCRIPTION Adds an AWS::ApiGateway::Deployment.CanarySetting resource property to the template. +The CanarySetting property type specifies settings for the canary deployment in this stage. +CanarySetting is a property of the StageDescription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html .PARAMETER PercentTraffic + The percent 0-100 of traffic diverted to a canary deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic PrimitiveType: Double UpdateType: Mutable .PARAMETER StageVariableOverrides + Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +29,8 @@ function Add-VSApiGatewayDeploymentCanarySetting { UpdateType: Mutable .PARAMETER UseStageCache + Whether the canary deployment uses the stage cache or not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentDeploymentCanarySettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentDeploymentCanarySettings.ps1 index 9219b4022..e48ac5c3d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentDeploymentCanarySettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentDeploymentCanarySettings.ps1 @@ -1,21 +1,26 @@ function Add-VSApiGatewayDeploymentDeploymentCanarySettings { <# .SYNOPSIS - Adds an AWS::ApiGateway::Deployment.DeploymentCanarySettings resource property to the template. + Adds an AWS::ApiGateway::Deployment.DeploymentCanarySettings resource property to the template. The DeploymentCanarySettings property type specifies settings for the canary deployment. .DESCRIPTION Adds an AWS::ApiGateway::Deployment.DeploymentCanarySettings resource property to the template. - +The DeploymentCanarySettings property type specifies settings for the canary deployment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html .PARAMETER PercentTraffic + The percentage 0-100 of traffic diverted to a canary deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-percenttraffic PrimitiveType: Double UpdateType: Immutable .PARAMETER StageVariableOverrides + Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. +Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-stagevariableoverrides DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +28,8 @@ function Add-VSApiGatewayDeploymentDeploymentCanarySettings { UpdateType: Immutable .PARAMETER UseStageCache + Whether the canary deployment uses the stage cache. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-usestagecache PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentMethodSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentMethodSetting.ps1 index dd0ef0873..0530b3a8b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentMethodSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentMethodSetting.ps1 @@ -1,61 +1,83 @@ function Add-VSApiGatewayDeploymentMethodSetting { <# .SYNOPSIS - Adds an AWS::ApiGateway::Deployment.MethodSetting resource property to the template. + Adds an AWS::ApiGateway::Deployment.MethodSetting resource property to the template. The MethodSetting property type configures settings for all methods in a stage. .DESCRIPTION Adds an AWS::ApiGateway::Deployment.MethodSetting resource property to the template. +The MethodSetting property type configures settings for all methods in a stage. +The MethodSettings property of the Amazon API Gateway Deployment StageDescription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html property type contains a list of MethodSetting property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html .PARAMETER CacheDataEncrypted + Indicates whether the cached responses are encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachedataencrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheTtlInSeconds + The time-to-live TTL period, in seconds, that specifies how long API Gateway caches responses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachettlinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER CachingEnabled + Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DataTraceEnabled + Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-datatraceenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HttpMethod + The HTTP method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-httpmethod PrimitiveType: String UpdateType: Mutable .PARAMETER LoggingLevel + The logging level for this method. For valid values, see the loggingLevel property of the Stage: https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel resource in the *Amazon API Gateway API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-logginglevel PrimitiveType: String UpdateType: Mutable .PARAMETER MetricsEnabled + Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-metricsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ResourcePath + The resource path for this method. Forward slashes / are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash /. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-resourcepath PrimitiveType: String UpdateType: Mutable .PARAMETER ThrottlingBurstLimit + The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-throttlingburstlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER ThrottlingRateLimit + The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-throttlingratelimit PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 index c2342c059..876573c2f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 @@ -1,76 +1,102 @@ function Add-VSApiGatewayDeploymentStageDescription { <# .SYNOPSIS - Adds an AWS::ApiGateway::Deployment.StageDescription resource property to the template. + Adds an AWS::ApiGateway::Deployment.StageDescription resource property to the template. StageDescription is a property of the AWS::ApiGateway::Deployment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html resource that configures a deployment stage. .DESCRIPTION Adds an AWS::ApiGateway::Deployment.StageDescription resource property to the template. - +StageDescription is a property of the AWS::ApiGateway::Deployment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html resource that configures a deployment stage. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html .PARAMETER AccessLogSetting + Specifies settings for logging access in this stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting Type: AccessLogSetting UpdateType: Mutable .PARAMETER CacheClusterEnabled + Indicates whether cache clustering is enabled for the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheClusterSize + The size of the stage's cache cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize PrimitiveType: String UpdateType: Mutable .PARAMETER CacheDataEncrypted + Indicates whether the cached responses are encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheTtlInSeconds + The time-to-live TTL period, in seconds, that specifies how long API Gateway caches responses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER CachingEnabled + Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CanarySetting + Specifies settings for the canary deployment in this stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting Type: CanarySetting UpdateType: Mutable .PARAMETER ClientCertificateId + The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid PrimitiveType: String UpdateType: Mutable .PARAMETER DataTraceEnabled + Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Description + A description of the purpose of the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description PrimitiveType: String UpdateType: Mutable .PARAMETER DocumentationVersion + The version identifier of the API documentation snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion PrimitiveType: String UpdateType: Mutable .PARAMETER LoggingLevel + The logging level for this method. For valid values, see the loggingLevel property of the Stage: https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel resource in the *Amazon API Gateway API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel PrimitiveType: String UpdateType: Mutable .PARAMETER MethodSettings + Configures settings for all of the stage's methods. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings DuplicatesAllowed: False ItemType: MethodSetting @@ -78,11 +104,15 @@ function Add-VSApiGatewayDeploymentStageDescription { UpdateType: Mutable .PARAMETER MetricsEnabled + Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Tags + An array of arbitrary tags key-value pairs to associate with the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-tags DuplicatesAllowed: True ItemType: Tag @@ -90,21 +120,30 @@ function Add-VSApiGatewayDeploymentStageDescription { UpdateType: Mutable .PARAMETER ThrottlingBurstLimit + The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER ThrottlingRateLimit + The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit PrimitiveType: Double UpdateType: Mutable .PARAMETER TracingEnabled + Specifies whether active tracing with X-ray is enabled for this stage. +For more information, see Trace API Gateway API Execution with AWS X-Ray: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Variables + A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: A-Za-z0-9-._~:/?#&=,]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDocumentationPartLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDocumentationPartLocation.ps1 index fa03b661b..5eb3323e5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDocumentationPartLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDocumentationPartLocation.ps1 @@ -1,36 +1,50 @@ function Add-VSApiGatewayDocumentationPartLocation { <# .SYNOPSIS - Adds an AWS::ApiGateway::DocumentationPart.Location resource property to the template. + Adds an AWS::ApiGateway::DocumentationPart.Location resource property to the template. The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to. Location is a property of the AWS::ApiGateway::DocumentationPart: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html resource. .DESCRIPTION Adds an AWS::ApiGateway::DocumentationPart.Location resource property to the template. +The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to. Location is a property of the AWS::ApiGateway::DocumentationPart: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html resource. +**Note** + +For more information about each property, including constraints and valid values, see DocumentationPart: https://docs.aws.amazon.com/apigateway/api-reference/resource/documentation-part/#location in the *Amazon API Gateway REST API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html .PARAMETER Method + The HTTP verb of a method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the targeted API entity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name PrimitiveType: String UpdateType: Immutable .PARAMETER Path + The URL path of the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path PrimitiveType: String UpdateType: Immutable .PARAMETER StatusCode + The HTTP status code of a response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of API entity that the documentation content applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDomainNameEndpointConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDomainNameEndpointConfiguration.ps1 index d135d54d0..1d79ed63f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDomainNameEndpointConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDomainNameEndpointConfiguration.ps1 @@ -1,16 +1,20 @@ function Add-VSApiGatewayDomainNameEndpointConfiguration { <# .SYNOPSIS - Adds an AWS::ApiGateway::DomainName.EndpointConfiguration resource property to the template. + Adds an AWS::ApiGateway::DomainName.EndpointConfiguration resource property to the template. The EndpointConfiguration property type specifies the endpoint types of an Amazon API Gateway domain name. .DESCRIPTION Adds an AWS::ApiGateway::DomainName.EndpointConfiguration resource property to the template. +The EndpointConfiguration property type specifies the endpoint types of an Amazon API Gateway domain name. +EndpointConfiguration is a property of the AWS::ApiGateway::DomainName: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html .PARAMETER Types + A list of endpoint types of an API or its custom domain name. For an edge-optimized API and its custom domain name, the endpoint type is EDGE. For a regional API and its custom domain name, the endpoint type is REGIONAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 index e9c355bf8..5c4997b06 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 @@ -1,16 +1,18 @@ function Add-VSApiGatewayMethodIntegration { <# .SYNOPSIS - Adds an AWS::ApiGateway::Method.Integration resource property to the template. + Adds an AWS::ApiGateway::Method.Integration resource property to the template. Integration is a property of the AWS::ApiGateway::Method: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html resource that specifies information about the target backend that a method calls. .DESCRIPTION Adds an AWS::ApiGateway::Method.Integration resource property to the template. - +Integration is a property of the AWS::ApiGateway::Method: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html resource that specifies information about the target backend that a method calls. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html .PARAMETER CacheKeyParameters + A list of request parameters whose values API Gateway caches. These parameters must also be specified in RequestParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters to be supported in CacheKeyParameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters DuplicatesAllowed: False PrimitiveItemType: String @@ -18,36 +20,55 @@ function Add-VSApiGatewayMethodIntegration { UpdateType: Mutable .PARAMETER CacheNamespace + An API-specific tag group of related cached parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace PrimitiveType: String UpdateType: Mutable .PARAMETER ConnectionId + The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectionid PrimitiveType: String UpdateType: Mutable .PARAMETER ConnectionType + The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectiontype PrimitiveType: String UpdateType: Mutable .PARAMETER ContentHandling + Specifies how to handle request payload content type conversions. Valid values are: ++ CONVERT_TO_BINARY: Converts a request payload from a base64-encoded string to a binary blob. ++ CONVERT_TO_TEXT: Converts a request payload from a binary blob to a base64-encoded string. +If this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the PassthroughBehaviors property is configured to support payload pass-through. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling PrimitiveType: String UpdateType: Mutable .PARAMETER Credentials + The credentials that are required for the integration. To specify an AWS Identity and Access Management IAM role that API Gateway assumes, specify the role's Amazon Resource Name ARN. To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. +To use resource-based permissions on the AWS Lambda Lambda function, don't specify this property. Use the AWS::Lambda::Permission: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html resource to permit API Gateway to call the function. For more information, see Allow Amazon API Gateway to Invoke a Lambda Function: https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#access-control-resource-based-example-apigateway-invoke-function in the *AWS Lambda Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials PrimitiveType: String UpdateType: Mutable .PARAMETER IntegrationHttpMethod + The integration's HTTP method type. +For the Type property, if you specify MOCK, this property is optional. For all other types, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod PrimitiveType: String UpdateType: Mutable .PARAMETER IntegrationResponses + The response that API Gateway provides after a method's backend completes processing a request. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses DuplicatesAllowed: False ItemType: IntegrationResponse @@ -55,11 +76,18 @@ function Add-VSApiGatewayMethodIntegration { UpdateType: Mutable .PARAMETER PassthroughBehavior + Indicates when API Gateway passes requests to the targeted backend. This behavior depends on the request's Content-Type header and whether you defined a mapping template for it. +For more information and valid values, see the passthroughBehavior: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/integration-put/#passthroughBehavior field in the *API Gateway API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER RequestParameters + The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs string-to-string mappings, with a destination as the key and a source as the value. +Specify the destination by using the following pattern integration.request.location.name, where *location* is query string, path, or header, and *name* is a valid, unique parameter name. +The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters DuplicatesAllowed: False PrimitiveItemType: String @@ -67,6 +95,10 @@ function Add-VSApiGatewayMethodIntegration { UpdateType: Mutable .PARAMETER RequestTemplates + A map of Apache Velocity templates that are applied on the request payload. The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value specified as a string, such as the following snippet: +"application/json": "{n "statusCode": 200n}" +For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates DuplicatesAllowed: False PrimitiveItemType: String @@ -74,16 +106,26 @@ function Add-VSApiGatewayMethodIntegration { UpdateType: Mutable .PARAMETER TimeoutInMillis + Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-timeoutinmillis PrimitiveType: Integer UpdateType: Mutable .PARAMETER Type + The type of backend that your method is running, such as HTTP or MOCK. For all of the valid values, see the type: https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#type property for the Integration resource in the *Amazon API Gateway REST API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type PrimitiveType: String UpdateType: Mutable .PARAMETER Uri + The Uniform Resource Identifier URI for the integration. +If you specify HTTP for the Type property, specify the API endpoint URL. +If you specify MOCK for the Type property, don't specify this property. +If you specify AWS for the Type property, specify an AWS service that follows this form: arn:aws:apigateway:*region*:*subdomain*.*service|service*:*path|action*/*service_api*. For example, a Lambda function URI follows this form: arn:aws:apigateway:*region*:lambda:path/*path*. The path is usually in the form /2015-03-31/functions/*LambdaFunctionARN*/invocations. For more information, see the uri property of the Integration: https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/ resource in the Amazon API Gateway REST API Reference. +If you specified HTTP or AWS for the Type property, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegrationResponse.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegrationResponse.ps1 index 1a013fbdc..62b2b0356 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegrationResponse.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegrationResponse.ps1 @@ -1,21 +1,32 @@ function Add-VSApiGatewayMethodIntegrationResponse { <# .SYNOPSIS - Adds an AWS::ApiGateway::Method.IntegrationResponse resource property to the template. + Adds an AWS::ApiGateway::Method.IntegrationResponse resource property to the template. IntegrationResponse is a property of the Amazon API Gateway Method Integration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html property type that specifies the response that API Gateway sends after a method's backend finishes processing a request. .DESCRIPTION Adds an AWS::ApiGateway::Method.IntegrationResponse resource property to the template. - +IntegrationResponse is a property of the Amazon API Gateway Method Integration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html property type that specifies the response that API Gateway sends after a method's backend finishes processing a request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html .PARAMETER ContentHandling + Specifies how to handle request payload content type conversions. Valid values are: ++ CONVERT_TO_BINARY: Converts a request payload from a base64-encoded string to a binary blob. ++ CONVERT_TO_TEXT: Converts a request payload from a binary blob to a base64-encoded string. +If this property isn't defined, the request payload is passed through from the method request to the integration request without modification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling PrimitiveType: String UpdateType: Mutable .PARAMETER ResponseParameters + The response parameters from the backend response that API Gateway sends to the method response. Specify response parameters as key-value pairs string-to-string mappings: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html. +Use the destination as the key and the source as the value: ++ The destination must be an existing response parameter in the MethodResponse: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html property. ++ The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on the destination specified in the request. +For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +34,8 @@ function Add-VSApiGatewayMethodIntegrationResponse { UpdateType: Mutable .PARAMETER ResponseTemplates + The templates that are used to transform the integration response body. Specify templates as key-value pairs string-to-string mappings, with a content type as the key and a template as the value. For more information, see API Gateway Mapping Template and Access Logging Variable Reference: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates DuplicatesAllowed: False PrimitiveItemType: String @@ -30,11 +43,15 @@ function Add-VSApiGatewayMethodIntegrationResponse { UpdateType: Mutable .PARAMETER SelectionPattern + A regular expression: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html that specifies which error strings or status codes from the backend map to the integration response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern PrimitiveType: String UpdateType: Mutable .PARAMETER StatusCode + The status code that API Gateway uses to map the integration response to a MethodResponse: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html status code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodMethodResponse.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodMethodResponse.ps1 index 007caf36f..904050e25 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodMethodResponse.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodMethodResponse.ps1 @@ -1,16 +1,18 @@ function Add-VSApiGatewayMethodMethodResponse { <# .SYNOPSIS - Adds an AWS::ApiGateway::Method.MethodResponse resource property to the template. + Adds an AWS::ApiGateway::Method.MethodResponse resource property to the template. MethodResponse is a property of the AWS::ApiGateway::Method: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html resource that defines the responses that can be sent to the client that calls a method. .DESCRIPTION Adds an AWS::ApiGateway::Method.MethodResponse resource property to the template. - +MethodResponse is a property of the AWS::ApiGateway::Method: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html resource that defines the responses that can be sent to the client that calls a method. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html .PARAMETER ResponseModels + The resources used for the response's content type. Specify response models as key-value pairs string-to-string maps, with a content type as the key and a Model: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html resource name as the value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSApiGatewayMethodMethodResponse { UpdateType: Mutable .PARAMETER ResponseParameters + Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs string-to-Boolean maps, with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where *name* is a valid, unique header name. The Boolean specifies whether a parameter is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters DuplicatesAllowed: False PrimitiveItemType: Boolean @@ -25,6 +29,8 @@ function Add-VSApiGatewayMethodMethodResponse { UpdateType: Mutable .PARAMETER StatusCode + The method response's status code, which you map to an IntegrationResponse: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 index fa0d141a5..582e98594 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 @@ -1,16 +1,23 @@ function Add-VSApiGatewayRestApiEndpointConfiguration { <# .SYNOPSIS - Adds an AWS::ApiGateway::RestApi.EndpointConfiguration resource property to the template. + Adds an AWS::ApiGateway::RestApi.EndpointConfiguration resource property to the template. The EndpointConfiguration property type specifies the endpoint types of a REST API. .DESCRIPTION Adds an AWS::ApiGateway::RestApi.EndpointConfiguration resource property to the template. +The EndpointConfiguration property type specifies the endpoint types of a REST API. +EndpointConfiguration is a property of the AWS::ApiGateway::RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html .PARAMETER Types + A list of endpoint types of an API or its custom domain name. Valid values include: ++ EDGE: For an edge-optimized API and its custom domain name. ++ REGIONAL: For a regional API and its custom domain name. ++ PRIVATE: For a private API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +25,8 @@ function Add-VSApiGatewayRestApiEndpointConfiguration { UpdateType: Mutable .PARAMETER VpcEndpointIds + + RestApi: https://docs.aws.amazon.com/apigateway/api-reference/resource/rest-api/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiS3Location.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiS3Location.ps1 index c82a184d0..0256ae3dd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiS3Location.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiS3Location.ps1 @@ -1,31 +1,43 @@ function Add-VSApiGatewayRestApiS3Location { <# .SYNOPSIS - Adds an AWS::ApiGateway::RestApi.S3Location resource property to the template. + Adds an AWS::ApiGateway::RestApi.S3Location resource property to the template. S3Location is a property of the AWS::ApiGateway::RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger file that defines a set of RESTful APIs in JSON or YAML. .DESCRIPTION Adds an AWS::ApiGateway::RestApi.S3Location resource property to the template. +S3Location is a property of the AWS::ApiGateway::RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger file that defines a set of RESTful APIs in JSON or YAML. +**Note** + +On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative: https://www.openapis.org/, becoming the foundation of the OpenAPI Specification. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html .PARAMETER Bucket + The name of the S3 bucket where the OpenAPI file is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER ETag + The Amazon S3 ETag a file checksum of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The file name of the OpenAPI file Amazon S3 object name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key PrimitiveType: String UpdateType: Mutable .PARAMETER Version + For versioning-enabled buckets, a specific version of the OpenAPI file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 index 40b4f13bb..f233399c0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 @@ -1,21 +1,27 @@ function Add-VSApiGatewayStageAccessLogSetting { <# .SYNOPSIS - Adds an AWS::ApiGateway::Stage.AccessLogSetting resource property to the template. + Adds an AWS::ApiGateway::Stage.AccessLogSetting resource property to the template. The AccessLogSetting property type specifies settings for logging access in this stage. .DESCRIPTION Adds an AWS::ApiGateway::Stage.AccessLogSetting resource property to the template. +The AccessLogSetting property type specifies settings for logging access in this stage. +AccessLogSetting is a property of the AWS::ApiGateway::Stage: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html .PARAMETER DestinationArn + The Amazon Resource Name ARN of the CloudWatch Logs log group to receive access logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn PrimitiveType: String UpdateType: Mutable .PARAMETER Format + A single line format of the access logs of data, as specified by selected $context variables: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference. The format must include at least $context.requestId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageCanarySetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageCanarySetting.ps1 index 8b2404873..c08db2714 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageCanarySetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageCanarySetting.ps1 @@ -1,26 +1,35 @@ function Add-VSApiGatewayStageCanarySetting { <# .SYNOPSIS - Adds an AWS::ApiGateway::Stage.CanarySetting resource property to the template. + Adds an AWS::ApiGateway::Stage.CanarySetting resource property to the template. The CanarySetting property type specifies settings for the canary deployment in this stage. .DESCRIPTION Adds an AWS::ApiGateway::Stage.CanarySetting resource property to the template. +The CanarySetting property type specifies settings for the canary deployment in this stage. +CanarySetting is a property of the AWS::ApiGateway::Stage: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html .PARAMETER DeploymentId + The identifier of the deployment that the stage points to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-deploymentid PrimitiveType: String UpdateType: Mutable .PARAMETER PercentTraffic + The percentage 0-100 of traffic diverted to a canary deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-percenttraffic PrimitiveType: Double UpdateType: Mutable .PARAMETER StageVariableOverrides + Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. +Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-stagevariableoverrides DuplicatesAllowed: False PrimitiveItemType: String @@ -28,6 +37,8 @@ function Add-VSApiGatewayStageCanarySetting { UpdateType: Mutable .PARAMETER UseStageCache + Whether the canary deployment uses the stage cache or not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-usestagecache PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageMethodSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageMethodSetting.ps1 index 68129c516..79ab42744 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageMethodSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageMethodSetting.ps1 @@ -1,61 +1,83 @@ function Add-VSApiGatewayStageMethodSetting { <# .SYNOPSIS - Adds an AWS::ApiGateway::Stage.MethodSetting resource property to the template. + Adds an AWS::ApiGateway::Stage.MethodSetting resource property to the template. The MethodSetting property type configures settings for all methods in a stage. .DESCRIPTION Adds an AWS::ApiGateway::Stage.MethodSetting resource property to the template. +The MethodSetting property type configures settings for all methods in a stage. +The MethodSettings property of the AWS::ApiGateway::Stage resource contains a list of MethodSetting property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html .PARAMETER CacheDataEncrypted + Indicates whether the cached responses are encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheTtlInSeconds + The time-to-live TTL period, in seconds, that specifies how long API Gateway caches responses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER CachingEnabled + Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DataTraceEnabled + Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HttpMethod + The HTTP method. You can use an asterisk * as a wildcard to apply method settings to multiple methods. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod PrimitiveType: String UpdateType: Mutable .PARAMETER LoggingLevel + The logging level for this method. For valid values, see the loggingLevel property of the Stage: https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel resource in the *Amazon API Gateway API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel PrimitiveType: String UpdateType: Mutable .PARAMETER MetricsEnabled + Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ResourcePath + The resource path for this method. Forward slashes / are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash /. You can use an asterisk * as a wildcard to apply method settings to multiple methods. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath PrimitiveType: String UpdateType: Mutable .PARAMETER ThrottlingBurstLimit + The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER ThrottlingRateLimit + The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanApiStage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanApiStage.ps1 index 53b37ba3c..76a242e82 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanApiStage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanApiStage.ps1 @@ -1,26 +1,33 @@ function Add-VSApiGatewayUsagePlanApiStage { <# .SYNOPSIS - Adds an AWS::ApiGateway::UsagePlan.ApiStage resource property to the template. + Adds an AWS::ApiGateway::UsagePlan.ApiStage resource property to the template. ApiStage is a property of the AWS::ApiGateway::UsagePlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html resource that specifies which stages and APIs to associate with a usage plan. .DESCRIPTION Adds an AWS::ApiGateway::UsagePlan.ApiStage resource property to the template. - +ApiStage is a property of the AWS::ApiGateway::UsagePlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html resource that specifies which stages and APIs to associate with a usage plan. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html .PARAMETER ApiId + The ID of an API that is in the specified Stage property that you want to associate with the usage plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid PrimitiveType: String UpdateType: Mutable .PARAMETER Stage + The name of the stage to associate with the usage plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage PrimitiveType: String UpdateType: Mutable .PARAMETER Throttle + Map containing method-level throttling information for API stage in a usage plan. +Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle DuplicatesAllowed: False ItemType: ThrottleSettings diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanQuotaSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanQuotaSettings.ps1 index 7abdc18f8..d5c6bca94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanQuotaSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanQuotaSettings.ps1 @@ -1,26 +1,32 @@ function Add-VSApiGatewayUsagePlanQuotaSettings { <# .SYNOPSIS - Adds an AWS::ApiGateway::UsagePlan.QuotaSettings resource property to the template. + Adds an AWS::ApiGateway::UsagePlan.QuotaSettings resource property to the template. QuotaSettings is a property of the AWS::ApiGateway::UsagePlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html resource that specifies the maximum number of requests users can make to your REST APIs. .DESCRIPTION Adds an AWS::ApiGateway::UsagePlan.QuotaSettings resource property to the template. - +QuotaSettings is a property of the AWS::ApiGateway::UsagePlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html resource that specifies the maximum number of requests users can make to your REST APIs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html .PARAMETER Limit + The maximum number of requests that users can make within the specified time period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit PrimitiveType: Integer UpdateType: Mutable .PARAMETER Offset + For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset PrimitiveType: Integer UpdateType: Mutable .PARAMETER Period + The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan: https://docs.aws.amazon.com/apigateway/api-reference/resource/usage-plan resource in the *Amazon API Gateway REST API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanThrottleSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanThrottleSettings.ps1 index d01c004cd..58261793c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanThrottleSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayUsagePlanThrottleSettings.ps1 @@ -1,21 +1,25 @@ function Add-VSApiGatewayUsagePlanThrottleSettings { <# .SYNOPSIS - Adds an AWS::ApiGateway::UsagePlan.ThrottleSettings resource property to the template. + Adds an AWS::ApiGateway::UsagePlan.ThrottleSettings resource property to the template. ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html resource that specifies the overall request rate (average requests per second and burst capacity when users call your REST APIs. .DESCRIPTION Adds an AWS::ApiGateway::UsagePlan.ThrottleSettings resource property to the template. - +ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html resource that specifies the overall request rate (average requests per second and burst capacity when users call your REST APIs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html .PARAMETER BurstLimit + The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity. For more information about request throttling, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER RateLimit + The API request steady-state rate limit average requests per second over an extended period of time. For more information about request throttling, see Manage API Request Throttling: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 index 72adfd668..5f5890695 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 @@ -1,26 +1,34 @@ function Add-VSApiGatewayV2DomainNameDomainNameConfiguration { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::DomainName.DomainNameConfiguration resource property to the template. + Adds an AWS::ApiGatewayV2::DomainName.DomainNameConfiguration resource property to the template. The DomainNameConfiguration property type specifies the configuration for a WebSocket's domain name. .DESCRIPTION Adds an AWS::ApiGatewayV2::DomainName.DomainNameConfiguration resource property to the template. +The DomainNameConfiguration property type specifies the configuration for a WebSocket's domain name. +DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html .PARAMETER EndpointType + The endpoint type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER CertificateName + The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatename PrimitiveType: String UpdateType: Mutable .PARAMETER CertificateArn + An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteParameterConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteParameterConstraints.ps1 index b5be685bb..efedd9f3f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteParameterConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteParameterConstraints.ps1 @@ -1,16 +1,18 @@ function Add-VSApiGatewayV2RouteParameterConstraints { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Route.ParameterConstraints resource property to the template. + Adds an AWS::ApiGatewayV2::Route.ParameterConstraints resource property to the template. Specifies whether the parameter is required. .DESCRIPTION Adds an AWS::ApiGatewayV2::Route.ParameterConstraints resource property to the template. - +Specifies whether the parameter is required. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-route-parameterconstraints.html .PARAMETER Required + Specifies whether the parameter is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-route-parameterconstraints.html#cfn-apigatewayv2-route-parameterconstraints-required PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteResponseParameterConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteResponseParameterConstraints.ps1 index ce74418b5..95e206c5d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteResponseParameterConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2RouteResponseParameterConstraints.ps1 @@ -1,16 +1,18 @@ function Add-VSApiGatewayV2RouteResponseParameterConstraints { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::RouteResponse.ParameterConstraints resource property to the template. + Adds an AWS::ApiGatewayV2::RouteResponse.ParameterConstraints resource property to the template. Specifies whether the parameter is required. .DESCRIPTION Adds an AWS::ApiGatewayV2::RouteResponse.ParameterConstraints resource property to the template. - +Specifies whether the parameter is required. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html .PARAMETER Required + Specifies whether the parameter is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html#cfn-apigatewayv2-routeresponse-parameterconstraints-required PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageAccessLogSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageAccessLogSettings.ps1 index 2c91d9768..b2c6d7cf0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageAccessLogSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageAccessLogSettings.ps1 @@ -1,21 +1,25 @@ function Add-VSApiGatewayV2StageAccessLogSettings { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Stage.AccessLogSettings resource property to the template. + Adds an AWS::ApiGatewayV2::Stage.AccessLogSettings resource property to the template. Settings for logging access in a stage. .DESCRIPTION Adds an AWS::ApiGatewayV2::Stage.AccessLogSettings resource property to the template. - +Settings for logging access in a stage. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html .PARAMETER Format + A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format PrimitiveType: String UpdateType: Mutable .PARAMETER DestinationArn + The ARN of the CloudWatch Logs log group to receive access logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-destinationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 index 4417ab668..20fa577f4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 @@ -1,36 +1,46 @@ function Add-VSApiGatewayV2StageRouteSettings { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Stage.RouteSettings resource property to the template. + Adds an AWS::ApiGatewayV2::Stage.RouteSettings resource property to the template. Represents a collection of route settings. .DESCRIPTION Adds an AWS::ApiGatewayV2::Stage.RouteSettings resource property to the template. - +Represents a collection of route settings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html .PARAMETER LoggingLevel + Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel PrimitiveType: String UpdateType: Mutable .PARAMETER DataTraceEnabled + Specifies whether true or not false data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ThrottlingBurstLimit + Specifies the throttling burst limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER DetailedMetricsEnabled + Specifies whether detailed metrics are enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-detailedmetricsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ThrottlingRateLimit + Specifies the throttling rate limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 index fb8032944..2c4047986 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshMeshEgressFilter { <# .SYNOPSIS - Adds an AWS::AppMesh::Mesh.EgressFilter resource property to the template. + Adds an AWS::AppMesh::Mesh.EgressFilter resource property to the template. An object representing the egress filter rules for a service mesh. .DESCRIPTION Adds an AWS::AppMesh::Mesh.EgressFilter resource property to the template. - +An object representing the egress filter rules for a service mesh. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html .PARAMETER Type + The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh and any traffic to *.amazonaws.com for AWS API calls. You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html#cfn-appmesh-mesh-egressfilter-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 index 551e75657..6d6c4bdd7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshMeshMeshSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::Mesh.MeshSpec resource property to the template. + Adds an AWS::AppMesh::Mesh.MeshSpec resource property to the template. An object representing the specification of a service mesh. .DESCRIPTION Adds an AWS::AppMesh::Mesh.MeshSpec resource property to the template. - +An object representing the specification of a service mesh. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html .PARAMETER EgressFilter + The egress filter rules for the service mesh. + Type: EgressFilter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html#cfn-appmesh-mesh-meshspec-egressfilter UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 index eea2d2a72..7387af1f9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 @@ -1,36 +1,46 @@ function Add-VSAppMeshRouteHeaderMatchMethod { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HeaderMatchMethod resource property to the template. + Adds an AWS::AppMesh::Route.HeaderMatchMethod resource property to the template. An object representing the method and value to match the header value sent with a request. Specify one match method. .DESCRIPTION Adds an AWS::AppMesh::Route.HeaderMatchMethod resource property to the template. - +An object representing the method and value to match the header value sent with a request. Specify one match method. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html .PARAMETER Suffix + The header value sent by the client must end with the specified characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-suffix PrimitiveType: String UpdateType: Mutable .PARAMETER Regex + The header value sent by the client must include the specified characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-regex PrimitiveType: String UpdateType: Mutable .PARAMETER Exact + The header value sent by the client must match the specified value exactly. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-exact PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + The header value sent by the client must begin with the specified characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Range + The object that specifies the range of numbers that the header value sent by the client must be included in. + Type: MatchRange Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-range UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 index 071ba9d7c..5064560a7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 @@ -1,26 +1,32 @@ function Add-VSAppMeshRouteHttpRoute { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRoute resource property to the template. + Adds an AWS::AppMesh::Route.HttpRoute resource property to the template. An object representing the HTTP routing specification for a route. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRoute resource property to the template. - +An object representing the HTTP routing specification for a route. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html .PARAMETER Action + The action to take if a match is determined. + Type: HttpRouteAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-action UpdateType: Mutable .PARAMETER RetryPolicy + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: HttpRetryPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-retrypolicy UpdateType: Mutable .PARAMETER Match + The criteria for determining an HTTP request match. + Type: HttpRouteMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-match UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 index 1c2b1bcb0..7ebe74029 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshRouteHttpRouteAction { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRouteAction resource property to the template. + Adds an AWS::AppMesh::Route.HttpRouteAction resource property to the template. An object representing the traffic distribution requirements for matched HTTP requests. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRouteAction resource property to the template. - +An object representing the traffic distribution requirements for matched HTTP requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html .PARAMETER WeightedTargets + The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html#cfn-appmesh-route-httprouteaction-weightedtargets ItemType: WeightedTarget diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 index 8b2994774..576ac9905 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 @@ -1,26 +1,32 @@ function Add-VSAppMeshRouteHttpRouteHeader { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRouteHeader resource property to the template. + Adds an AWS::AppMesh::Route.HttpRouteHeader resource property to the template. An object representing the HTTP header in the request. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRouteHeader resource property to the template. - +An object representing the HTTP header in the request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html .PARAMETER Invert + Specify True to match the opposite of the HeaderMatchMethod method and value. The default value is False. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-invert PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + A name for the HTTP header in the client request that will be matched on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-name PrimitiveType: String UpdateType: Mutable .PARAMETER Match + The HeaderMatchMethod object. + Type: HeaderMatchMethod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-match UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 index d9315de54..fe9d5562e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 @@ -1,32 +1,40 @@ function Add-VSAppMeshRouteHttpRouteMatch { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRouteMatch resource property to the template. + Adds an AWS::AppMesh::Route.HttpRouteMatch resource property to the template. An object representing the requirements for a route to match HTTP requests for a virtual router. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRouteMatch resource property to the template. - +An object representing the requirements for a route to match HTTP requests for a virtual router. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html .PARAMETER Scheme + The client request header scheme to match on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-scheme PrimitiveType: String UpdateType: Mutable .PARAMETER Headers + The client request headers to match on. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-headers ItemType: HttpRouteHeader UpdateType: Mutable .PARAMETER Prefix + Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Method + The client request header method to match on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-method PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 index 67863825e..7e52c01ac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshRouteMatchRange { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.MatchRange resource property to the template. + Adds an AWS::AppMesh::Route.MatchRange resource property to the template. The range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. .DESCRIPTION Adds an AWS::AppMesh::Route.MatchRange resource property to the template. - +The range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html .PARAMETER Start + The start of the range. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html#cfn-appmesh-route-matchrange-start PrimitiveType: Integer UpdateType: Mutable .PARAMETER End + The end of the range. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html#cfn-appmesh-route-matchrange-end PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 index dc35d7c25..b2b585c6b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 @@ -1,36 +1,46 @@ function Add-VSAppMeshRouteRouteSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.RouteSpec resource property to the template. + Adds an AWS::AppMesh::Route.RouteSpec resource property to the template. An object representing the specification of a route. .DESCRIPTION Adds an AWS::AppMesh::Route.RouteSpec resource property to the template. - +An object representing the specification of a route. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html .PARAMETER HttpRoute + The HTTP routing information for the route. + Type: HttpRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-httproute UpdateType: Mutable .PARAMETER Priority + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER Http2Route + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: HttpRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-http2route UpdateType: Mutable .PARAMETER GrpcRoute + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: GrpcRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-grpcroute UpdateType: Mutable .PARAMETER TcpRoute + The TCP routing information for the route. + Type: TcpRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-tcproute UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 index b4e811ac4..b155a5d75 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshRouteTcpRoute { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.TcpRoute resource property to the template. + Adds an AWS::AppMesh::Route.TcpRoute resource property to the template. An object representing the TCP routing specification for a route. .DESCRIPTION Adds an AWS::AppMesh::Route.TcpRoute resource property to the template. - +An object representing the TCP routing specification for a route. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html .PARAMETER Action + The action to take if a match is determined. + Type: TcpRouteAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html#cfn-appmesh-route-tcproute-action UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 index bc5570f64..fe2b13cb6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshRouteTcpRouteAction { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.TcpRouteAction resource property to the template. + Adds an AWS::AppMesh::Route.TcpRouteAction resource property to the template. An object representing the traffic distribution requirements for matched TCP requests. .DESCRIPTION Adds an AWS::AppMesh::Route.TcpRouteAction resource property to the template. - +An object representing the traffic distribution requirements for matched TCP requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html .PARAMETER WeightedTargets + The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html#cfn-appmesh-route-tcprouteaction-weightedtargets ItemType: WeightedTarget diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 index 463016041..c165fc2e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshRouteWeightedTarget { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.WeightedTarget resource property to the template. + Adds an AWS::AppMesh::Route.WeightedTarget resource property to the template. An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. .DESCRIPTION Adds an AWS::AppMesh::Route.WeightedTarget resource property to the template. - +An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html .PARAMETER VirtualNode + The virtual node to associate with the weighted target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-virtualnode PrimitiveType: String UpdateType: Mutable .PARAMETER Weight + The relative weight of the weighted target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-weight PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 index e5ae7e342..1ac944a15 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualNodeAccessLog { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.AccessLog resource property to the template. + Adds an AWS::AppMesh::VirtualNode.AccessLog resource property to the template. An object representing the access logging information for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.AccessLog resource property to the template. - +An object representing the access logging information for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-accesslog.html .PARAMETER File + The file object to send virtual node access logs to. + Type: FileAccessLog Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-accesslog.html#cfn-appmesh-virtualnode-accesslog-file UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 index 602b95a92..e136db366 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute resource property to the template. + Adds an AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute resource property to the template. An object representing the AWS Cloud Map attribute information for your virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute resource property to the template. - +An object representing the AWS Cloud Map attribute information for your virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html .PARAMETER Value + The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html#cfn-appmesh-virtualnode-awscloudmapinstanceattribute-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html#cfn-appmesh-virtualnode-awscloudmapinstanceattribute-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 index 784724276..c38c672eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 @@ -1,26 +1,32 @@ function Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery resource property to the template. + Adds an AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery resource property to the template. An object representing the AWS Cloud Map service discovery information for your virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery resource property to the template. - +An object representing the AWS Cloud Map service discovery information for your virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html .PARAMETER NamespaceName + The name of the AWS Cloud Map namespace to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-namespacename PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceName + The name of the AWS Cloud Map service to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-servicename PrimitiveType: String UpdateType: Mutable .PARAMETER Attributes + A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-attributes ItemType: AwsCloudMapInstanceAttribute diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 index 7ff2e0e83..4f8c1315a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualNodeBackend { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.Backend resource property to the template. + Adds an AWS::AppMesh::VirtualNode.Backend resource property to the template. An object representing the backends that a virtual node is expected to send outbound traffic to. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.Backend resource property to the template. - +An object representing the backends that a virtual node is expected to send outbound traffic to. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html .PARAMETER VirtualService + Specifies a virtual service to use as a backend for a virtual node. + Type: VirtualServiceBackend Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html#cfn-appmesh-virtualnode-backend-virtualservice UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 index d469b38db..189c5d480 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualNodeDnsServiceDiscovery { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.DnsServiceDiscovery resource property to the template. + Adds an AWS::AppMesh::VirtualNode.DnsServiceDiscovery resource property to the template. An object representing the DNS service discovery information for your virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.DnsServiceDiscovery resource property to the template. - +An object representing the DNS service discovery information for your virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html .PARAMETER Hostname + Specifies the DNS service discovery hostname for the virtual node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html#cfn-appmesh-virtualnode-dnsservicediscovery-hostname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 index a16d3f9a8..db1fbb27e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 @@ -1,16 +1,19 @@ function Add-VSAppMeshVirtualNodeFileAccessLog { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.FileAccessLog resource property to the template. + Adds an AWS::AppMesh::VirtualNode.FileAccessLog resource property to the template. An object representing an access log file. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.FileAccessLog resource property to the template. - +An object representing an access log file. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-fileaccesslog.html .PARAMETER Path + The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk. +The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-fileaccesslog.html#cfn-appmesh-virtualnode-fileaccesslog-path PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 index 90ab04942..9a1c6ee7d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 @@ -1,46 +1,60 @@ function Add-VSAppMeshVirtualNodeHealthCheck { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.HealthCheck resource property to the template. + Adds an AWS::AppMesh::VirtualNode.HealthCheck resource property to the template. An object representing the health check policy for a virtual node's listener. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.HealthCheck resource property to the template. - +An object representing the health check policy for a virtual node's listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html .PARAMETER Path + The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-path PrimitiveType: String UpdateType: Mutable .PARAMETER UnhealthyThreshold + The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-unhealthythreshold PrimitiveType: Integer UpdateType: Mutable .PARAMETER Port + The destination port for the health check request. This port must match the port defined in the PortMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html#cfn-appmesh-virtualrouter-virtualrouterlistener-portmapping for the listener. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER HealthyThreshold + The number of consecutive successful health checks that must occur before declaring listener healthy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-healthythreshold PrimitiveType: Integer UpdateType: Mutable .PARAMETER TimeoutMillis + The amount of time to wait when receiving a response from the health check, in milliseconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-timeoutmillis PrimitiveType: Integer UpdateType: Mutable .PARAMETER Protocol + The protocol for the health check request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER IntervalMillis + The time period in milliseconds between each health check execution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-intervalmillis PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 index 321c7c3e5..5eec9934a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshVirtualNodeListener { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.Listener resource property to the template. + Adds an AWS::AppMesh::VirtualNode.Listener resource property to the template. An object representing a listener for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.Listener resource property to the template. - +An object representing a listener for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html .PARAMETER HealthCheck + The health check information for the listener. + Type: HealthCheck Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-healthcheck UpdateType: Mutable .PARAMETER PortMapping + The port mapping information for the listener. + Type: PortMapping Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-portmapping UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 index b52d029ea..04ee42d97 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualNodeLogging { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.Logging resource property to the template. + Adds an AWS::AppMesh::VirtualNode.Logging resource property to the template. An object representing the logging information for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.Logging resource property to the template. - +An object representing the logging information for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-logging.html .PARAMETER AccessLog + The access log configuration for a virtual node. + Type: AccessLog Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-logging.html#cfn-appmesh-virtualnode-logging-accesslog UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 index 0bff38925..6f8fcc7c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshVirtualNodePortMapping { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.PortMapping resource property to the template. + Adds an AWS::AppMesh::VirtualNode.PortMapping resource property to the template. An object representing a virtual node or virtual router listener port mapping. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.PortMapping resource property to the template. - +An object representing a virtual node or virtual router listener port mapping. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html .PARAMETER Port + The port used for the port mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html#cfn-appmesh-virtualnode-portmapping-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER Protocol + The protocol used for the port mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html#cfn-appmesh-virtualnode-portmapping-protocol PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 index 7f8b5f4c8..fd22adf04 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshVirtualNodeServiceDiscovery { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.ServiceDiscovery resource property to the template. + Adds an AWS::AppMesh::VirtualNode.ServiceDiscovery resource property to the template. An object representing the service discovery information for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.ServiceDiscovery resource property to the template. - +An object representing the service discovery information for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html .PARAMETER DNS + Specifies the DNS information for the virtual node. + Type: DnsServiceDiscovery Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html#cfn-appmesh-virtualnode-servicediscovery-dns UpdateType: Mutable .PARAMETER AWSCloudMap + Specifies any AWS Cloud Map information for the virtual node. + Type: AwsCloudMapServiceDiscovery Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html#cfn-appmesh-virtualnode-servicediscovery-awscloudmap UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 index 9321e9141..95de80bf2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 @@ -1,33 +1,41 @@ function Add-VSAppMeshVirtualNodeVirtualNodeSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.VirtualNodeSpec resource property to the template. + Adds an AWS::AppMesh::VirtualNode.VirtualNodeSpec resource property to the template. An object representing the specification of a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.VirtualNodeSpec resource property to the template. - +An object representing the specification of a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html .PARAMETER Logging + The inbound and outbound access logging information for the virtual node. + Type: Logging Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-logging UpdateType: Mutable .PARAMETER Backends + The backends that the virtual node is expected to send outbound traffic to. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-backends ItemType: Backend UpdateType: Mutable .PARAMETER Listeners + The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-listeners ItemType: Listener UpdateType: Mutable .PARAMETER ServiceDiscovery + The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. + Type: ServiceDiscovery Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-servicediscovery UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 index 670a1623d..adfd52e0f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualNodeVirtualServiceBackend { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.VirtualServiceBackend resource property to the template. + Adds an AWS::AppMesh::VirtualNode.VirtualServiceBackend resource property to the template. An object representing a virtual service backend for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.VirtualServiceBackend resource property to the template. - +An object representing a virtual service backend for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html .PARAMETER VirtualServiceName + The name of the virtual service that is acting as a virtual node backend. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html#cfn-appmesh-virtualnode-virtualservicebackend-virtualservicename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 index 76158b2ca..9c840d898 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshVirtualRouterPortMapping { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualRouter.PortMapping resource property to the template. + Adds an AWS::AppMesh::VirtualRouter.PortMapping resource property to the template. An object representing a virtual router listener port mapping. .DESCRIPTION Adds an AWS::AppMesh::VirtualRouter.PortMapping resource property to the template. - +An object representing a virtual router listener port mapping. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html .PARAMETER Port + The port used for the port mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html#cfn-appmesh-virtualrouter-portmapping-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER Protocol + The protocol used for the port mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html#cfn-appmesh-virtualrouter-portmapping-protocol PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 index 6cae557e0..0fd24683a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualRouterVirtualRouterListener { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualRouter.VirtualRouterListener resource property to the template. + Adds an AWS::AppMesh::VirtualRouter.VirtualRouterListener resource property to the template. An object representing a virtual router listener. .DESCRIPTION Adds an AWS::AppMesh::VirtualRouter.VirtualRouterListener resource property to the template. - +An object representing a virtual router listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html .PARAMETER PortMapping + The port mapping information for the listener. + Type: PortMapping Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html#cfn-appmesh-virtualrouter-virtualrouterlistener-portmapping UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 index bdcd72481..0246b4064 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualRouterVirtualRouterSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualRouter.VirtualRouterSpec resource property to the template. + Adds an AWS::AppMesh::VirtualRouter.VirtualRouterSpec resource property to the template. An object representing the specification of a virtual router. .DESCRIPTION Adds an AWS::AppMesh::VirtualRouter.VirtualRouterSpec resource property to the template. - +An object representing the specification of a virtual router. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html .PARAMETER Listeners + The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html#cfn-appmesh-virtualrouter-virtualrouterspec-listeners ItemType: VirtualRouterListener diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 index ce53cf551..475f1bb1a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualNodeServiceProvider resource property to the template. + Adds an AWS::AppMesh::VirtualService.VirtualNodeServiceProvider resource property to the template. An object representing a virtual node service provider. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualNodeServiceProvider resource property to the template. - +An object representing a virtual node service provider. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html .PARAMETER VirtualNodeName + The name of the virtual node that is acting as a service provider. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html#cfn-appmesh-virtualservice-virtualnodeserviceprovider-virtualnodename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 index 4e31c1b2a..120f501b7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualRouterServiceProvider resource property to the template. + Adds an AWS::AppMesh::VirtualService.VirtualRouterServiceProvider resource property to the template. An object representing a virtual node service provider. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualRouterServiceProvider resource property to the template. - +An object representing a virtual node service provider. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html .PARAMETER VirtualRouterName + The name of the virtual router that is acting as a service provider. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html#cfn-appmesh-virtualservice-virtualrouterserviceprovider-virtualroutername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 index f20021f92..6f145ad0b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshVirtualServiceVirtualServiceProvider { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualServiceProvider resource property to the template. + Adds an AWS::AppMesh::VirtualService.VirtualServiceProvider resource property to the template. An object representing the provider for a virtual service. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualServiceProvider resource property to the template. - +An object representing the provider for a virtual service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html .PARAMETER VirtualNode + The virtual node associated with a virtual service. + Type: VirtualNodeServiceProvider Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html#cfn-appmesh-virtualservice-virtualserviceprovider-virtualnode UpdateType: Mutable .PARAMETER VirtualRouter + The virtual router associated with a virtual service. + Type: VirtualRouterServiceProvider Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html#cfn-appmesh-virtualservice-virtualserviceprovider-virtualrouter UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 index 927554b1d..2984ac30a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshVirtualServiceVirtualServiceSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualServiceSpec resource property to the template. + Adds an AWS::AppMesh::VirtualService.VirtualServiceSpec resource property to the template. An object representing the specification of a virtual service. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualServiceSpec resource property to the template. - +An object representing the specification of a virtual service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.html .PARAMETER Provider + The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router. + Type: VirtualServiceProvider Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.html#cfn-appmesh-virtualservice-virtualservicespec-provider UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamDirectoryConfigServiceAccountCredentials.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamDirectoryConfigServiceAccountCredentials.ps1 index 9aa1434f4..c6a56e5b8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamDirectoryConfigServiceAccountCredentials.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamDirectoryConfigServiceAccountCredentials.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamDirectoryConfigServiceAccountCredentials { <# .SYNOPSIS - Adds an AWS::AppStream::DirectoryConfig.ServiceAccountCredentials resource property to the template. + Adds an AWS::AppStream::DirectoryConfig.ServiceAccountCredentials resource property to the template. The credentials for the service account used by the streaming instance to connect to the directory. .DESCRIPTION Adds an AWS::AppStream::DirectoryConfig.ServiceAccountCredentials resource property to the template. - +The credentials for the service account used by the streaming instance to connect to the directory. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html .PARAMETER AccountName + The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountname PrimitiveType: String UpdateType: Mutable .PARAMETER AccountPassword + The password for the account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountpassword PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetComputeCapacity.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetComputeCapacity.ps1 index 8949ecdd6..ecfb2bf24 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetComputeCapacity.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetComputeCapacity.ps1 @@ -1,16 +1,18 @@ function Add-VSAppStreamFleetComputeCapacity { <# .SYNOPSIS - Adds an AWS::AppStream::Fleet.ComputeCapacity resource property to the template. + Adds an AWS::AppStream::Fleet.ComputeCapacity resource property to the template. The desired capacity for a fleet. .DESCRIPTION Adds an AWS::AppStream::Fleet.ComputeCapacity resource property to the template. - +The desired capacity for a fleet. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html .PARAMETER DesiredInstances + The desired number of streaming instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html#cfn-appstream-fleet-computecapacity-desiredinstances PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetDomainJoinInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetDomainJoinInfo.ps1 index 366b33d65..c07670019 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetDomainJoinInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetDomainJoinInfo.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamFleetDomainJoinInfo { <# .SYNOPSIS - Adds an AWS::AppStream::Fleet.DomainJoinInfo resource property to the template. + Adds an AWS::AppStream::Fleet.DomainJoinInfo resource property to the template. The name of the directory and organizational unit (OU to use to join a fleet to a Microsoft Active Directory domain. .DESCRIPTION Adds an AWS::AppStream::Fleet.DomainJoinInfo resource property to the template. - +The name of the directory and organizational unit (OU to use to join a fleet to a Microsoft Active Directory domain. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html .PARAMETER OrganizationalUnitDistinguishedName + The distinguished name of the organizational unit for computer accounts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html#cfn-appstream-fleet-domainjoininfo-organizationalunitdistinguishedname PrimitiveType: String UpdateType: Mutable .PARAMETER DirectoryName + The fully qualified name of the directory for example, corp.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html#cfn-appstream-fleet-domainjoininfo-directoryname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetVpcConfig.ps1 index 59e0414f8..3b0f3f085 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamFleetVpcConfig.ps1 @@ -1,22 +1,26 @@ function Add-VSAppStreamFleetVpcConfig { <# .SYNOPSIS - Adds an AWS::AppStream::Fleet.VpcConfig resource property to the template. + Adds an AWS::AppStream::Fleet.VpcConfig resource property to the template. The VPC configuration information for the fleet. .DESCRIPTION Adds an AWS::AppStream::Fleet.VpcConfig resource property to the template. - +The VPC configuration information for the fleet. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-vpcconfig.html .PARAMETER SubnetIds + The identifiers of the subnets to which a network interface is attached from the fleet instance. Fleet instances can use one or two subnets. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-vpcconfig.html#cfn-appstream-fleet-vpcconfig-subnetids UpdateType: Mutable .PARAMETER SecurityGroupIds + The identifiers of the security groups for the fleet. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-vpcconfig.html#cfn-appstream-fleet-vpcconfig-securitygroupids diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderDomainJoinInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderDomainJoinInfo.ps1 index b16b31314..2c73a9fe5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderDomainJoinInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderDomainJoinInfo.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamImageBuilderDomainJoinInfo { <# .SYNOPSIS - Adds an AWS::AppStream::ImageBuilder.DomainJoinInfo resource property to the template. + Adds an AWS::AppStream::ImageBuilder.DomainJoinInfo resource property to the template. The name of the directory and organizational unit (OU to use to join the image builder to a Microsoft Active Directory domain. .DESCRIPTION Adds an AWS::AppStream::ImageBuilder.DomainJoinInfo resource property to the template. - +The name of the directory and organizational unit (OU to use to join the image builder to a Microsoft Active Directory domain. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-domainjoininfo.html .PARAMETER OrganizationalUnitDistinguishedName + The distinguished name of the organizational unit for computer accounts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-domainjoininfo.html#cfn-appstream-imagebuilder-domainjoininfo-organizationalunitdistinguishedname PrimitiveType: String UpdateType: Mutable .PARAMETER DirectoryName + The fully qualified name of the directory for example, corp.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-domainjoininfo.html#cfn-appstream-imagebuilder-domainjoininfo-directoryname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderVpcConfig.ps1 index 6f6dbdd6e..9b51c286a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderVpcConfig.ps1 @@ -1,22 +1,26 @@ function Add-VSAppStreamImageBuilderVpcConfig { <# .SYNOPSIS - Adds an AWS::AppStream::ImageBuilder.VpcConfig resource property to the template. + Adds an AWS::AppStream::ImageBuilder.VpcConfig resource property to the template. The VPC configuration for the image builder. .DESCRIPTION Adds an AWS::AppStream::ImageBuilder.VpcConfig resource property to the template. - +The VPC configuration for the image builder. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-vpcconfig.html .PARAMETER SecurityGroupIds + The identifiers of the security groups for the image builder. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-vpcconfig.html#cfn-appstream-imagebuilder-vpcconfig-securitygroupids UpdateType: Mutable .PARAMETER SubnetIds + The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-vpcconfig.html#cfn-appstream-imagebuilder-vpcconfig-subnetids diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackApplicationSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackApplicationSettings.ps1 index 515143fc3..37cc25603 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackApplicationSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackApplicationSettings.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamStackApplicationSettings { <# .SYNOPSIS - Adds an AWS::AppStream::Stack.ApplicationSettings resource property to the template. + Adds an AWS::AppStream::Stack.ApplicationSettings resource property to the template. The persistent application settings for users of a stack. .DESCRIPTION Adds an AWS::AppStream::Stack.ApplicationSettings resource property to the template. - +The persistent application settings for users of a stack. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-applicationsettings.html .PARAMETER SettingsGroup + The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-applicationsettings.html#cfn-appstream-stack-applicationsettings-settingsgroup PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Enables or disables persistent application settings for users during their streaming sessions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-applicationsettings.html#cfn-appstream-stack-applicationsettings-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackStorageConnector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackStorageConnector.ps1 index d37ae42a5..9321a02ed 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackStorageConnector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackStorageConnector.ps1 @@ -1,27 +1,33 @@ function Add-VSAppStreamStackStorageConnector { <# .SYNOPSIS - Adds an AWS::AppStream::Stack.StorageConnector resource property to the template. + Adds an AWS::AppStream::Stack.StorageConnector resource property to the template. A connector that enables persistent storage for users. .DESCRIPTION Adds an AWS::AppStream::Stack.StorageConnector resource property to the template. - +A connector that enables persistent storage for users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html .PARAMETER Domains + The names of the domains for the account. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-domains UpdateType: Mutable .PARAMETER ResourceIdentifier + The ARN of the storage connector. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-resourceidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER ConnectorType + The type of storage connector. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-connectortype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackUserSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackUserSetting.ps1 index af5bdf0f2..cf9bd2a4a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackUserSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackUserSetting.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamStackUserSetting { <# .SYNOPSIS - Adds an AWS::AppStream::Stack.UserSetting resource property to the template. + Adds an AWS::AppStream::Stack.UserSetting resource property to the template. Specifies an action and whether the action is enabled or disabled for users during their streaming sessions. .DESCRIPTION Adds an AWS::AppStream::Stack.UserSetting resource property to the template. - +Specifies an action and whether the action is enabled or disabled for users during their streaming sessions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html .PARAMETER Action + The action that is enabled or disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html#cfn-appstream-stack-usersetting-action PrimitiveType: String UpdateType: Mutable .PARAMETER Permission + Indicates whether the action is enabled or disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html#cfn-appstream-stack-usersetting-permission PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAuthorizationConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAuthorizationConfig.ps1 index 4fa409106..bbccc7d82 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAuthorizationConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAuthorizationConfig.ps1 @@ -1,21 +1,28 @@ function Add-VSAppSyncDataSourceAuthorizationConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.AuthorizationConfig resource property to the template. + Adds an AWS::AppSync::DataSource.AuthorizationConfig resource property to the template. The AuthorizationConfig property type specifies the authorization type and configuration for an AWS AppSync http data source. .DESCRIPTION Adds an AWS::AppSync::DataSource.AuthorizationConfig resource property to the template. +The AuthorizationConfig property type specifies the authorization type and configuration for an AWS AppSync http data source. +AuthorizationConfig is a property of the AWS AppSync DataSource HttpConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-authorizationconfig.html .PARAMETER AwsIamConfig + The AWS IAM settings. + Type: AwsIamConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-authorizationconfig.html#cfn-appsync-datasource-authorizationconfig-awsiamconfig UpdateType: Mutable .PARAMETER AuthorizationType + The authorization type required by the HTTP endpoint. ++ **AWS_IAM**: The authorization type is Sigv4. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-authorizationconfig.html#cfn-appsync-datasource-authorizationconfig-authorizationtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAwsIamConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAwsIamConfig.ps1 index 8b82d9a5d..c16662518 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAwsIamConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceAwsIamConfig.ps1 @@ -1,21 +1,27 @@ function Add-VSAppSyncDataSourceAwsIamConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.AwsIamConfig resource property to the template. + Adds an AWS::AppSync::DataSource.AwsIamConfig resource property to the template. Use the AwsIamConfig property type to specify AwsIamConfig for a AWS AppSync authorizaton. .DESCRIPTION Adds an AWS::AppSync::DataSource.AwsIamConfig resource property to the template. +Use the AwsIamConfig property type to specify AwsIamConfig for a AWS AppSync authorizaton. +AwsIamConfig is a property of the AWS AppSync DataSource AuthorizationConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig-authorizationconfig.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-awsiamconfig.html .PARAMETER SigningRegion + The signing region for AWS IAM authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-awsiamconfig.html#cfn-appsync-datasource-awsiamconfig-signingregion PrimitiveType: String UpdateType: Mutable .PARAMETER SigningServiceName + The signing service name for AWS IAM authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-awsiamconfig.html#cfn-appsync-datasource-awsiamconfig-signingservicename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 index 9fc64c669..fbb77ef55 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 @@ -1,36 +1,48 @@ function Add-VSAppSyncDataSourceDynamoDBConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.DynamoDBConfig resource property to the template. + Adds an AWS::AppSync::DataSource.DynamoDBConfig resource property to the template. The DynamoDBConfig property type specifies the AwsRegion and TableName for an Amazon DynamoDB table in your account for an AWS AppSync data source. .DESCRIPTION Adds an AWS::AppSync::DataSource.DynamoDBConfig resource property to the template. +The DynamoDBConfig property type specifies the AwsRegion and TableName for an Amazon DynamoDB table in your account for an AWS AppSync data source. +DynamoDBConfig is a property of the AWS::AppSync::DataSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html .PARAMETER TableName + The table name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER AwsRegion + The AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-awsregion PrimitiveType: String UpdateType: Mutable .PARAMETER Versioned + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-versioned PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DeltaSyncConfig + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: DeltaSyncConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-deltasyncconfig UpdateType: Mutable .PARAMETER UseCallerCredentials + Set to TRUE to use AWS IAM with this data source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-usecallercredentials PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceElasticsearchConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceElasticsearchConfig.ps1 index 1347e10f7..75a13cdf5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceElasticsearchConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceElasticsearchConfig.ps1 @@ -1,21 +1,27 @@ function Add-VSAppSyncDataSourceElasticsearchConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.ElasticsearchConfig resource property to the template. + Adds an AWS::AppSync::DataSource.ElasticsearchConfig resource property to the template. The ElasticsearchConfig property type specifies the AwsRegion and Endpoints for an Amazon Elasticsearch Service domain in your account for an AWS AppSync data source. .DESCRIPTION Adds an AWS::AppSync::DataSource.ElasticsearchConfig resource property to the template. +The ElasticsearchConfig property type specifies the AwsRegion and Endpoints for an Amazon Elasticsearch Service domain in your account for an AWS AppSync data source. +ElasticsearchConfig is a property of the AWS::AppSync::DataSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html .PARAMETER AwsRegion + The AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html#cfn-appsync-datasource-elasticsearchconfig-awsregion PrimitiveType: String UpdateType: Mutable .PARAMETER Endpoint + The endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html#cfn-appsync-datasource-elasticsearchconfig-endpoint PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceHttpConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceHttpConfig.ps1 index 13959fc86..e7f535cdb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceHttpConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceHttpConfig.ps1 @@ -1,21 +1,27 @@ function Add-VSAppSyncDataSourceHttpConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.HttpConfig resource property to the template. + Adds an AWS::AppSync::DataSource.HttpConfig resource property to the template. Use the HttpConfig property type to specify HttpConfig for an AWS AppSync data source. .DESCRIPTION Adds an AWS::AppSync::DataSource.HttpConfig resource property to the template. +Use the HttpConfig property type to specify HttpConfig for an AWS AppSync data source. +HttpConfig is a property of the AWS::AppSync::DataSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html .PARAMETER Endpoint + The endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html#cfn-appsync-datasource-httpconfig-endpoint PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizationConfig + The authorization configuration. + Type: AuthorizationConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html#cfn-appsync-datasource-httpconfig-authorizationconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceLambdaConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceLambdaConfig.ps1 index a7a3ce9a4..2a26a4679 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceLambdaConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceLambdaConfig.ps1 @@ -1,16 +1,20 @@ function Add-VSAppSyncDataSourceLambdaConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.LambdaConfig resource property to the template. + Adds an AWS::AppSync::DataSource.LambdaConfig resource property to the template. The LambdaConfig property type specifies the Lambda function ARN for an AWS AppSync data source. .DESCRIPTION Adds an AWS::AppSync::DataSource.LambdaConfig resource property to the template. +The LambdaConfig property type specifies the Lambda function ARN for an AWS AppSync data source. +LambdaConfig is a property of the AWS::AppSync::DataSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-lambdaconfig.html .PARAMETER LambdaFunctionArn + The ARN for the Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-lambdaconfig.html#cfn-appsync-datasource-lambdaconfig-lambdafunctionarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 index c990c56c6..6c8fd7cbb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 @@ -1,36 +1,48 @@ function Add-VSAppSyncDataSourceRdsHttpEndpointConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.RdsHttpEndpointConfig resource property to the template. + Adds an AWS::AppSync::DataSource.RdsHttpEndpointConfig resource property to the template. Use the RdsHttpEndpointConfig property type to specify RdsHttpEndpoint for an AWS AppSync relational database. .DESCRIPTION Adds an AWS::AppSync::DataSource.RdsHttpEndpointConfig resource property to the template. +Use the RdsHttpEndpointConfig property type to specify RdsHttpEndpoint for an AWS AppSync relational database. +RdsHttpEndpointConfig is a property of the AWS AppSync DataSource RelationalDatabaseConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html .PARAMETER AwsRegion + AWS Region for RDS HTTP endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-awsregion PrimitiveType: String UpdateType: Mutable .PARAMETER Schema + Logical schema name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-schema PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName + Logical database name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER DbClusterIdentifier + Amazon RDS cluster identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-dbclusteridentifier PrimitiveType: String UpdateType: Mutable .PARAMETER AwsSecretStoreArn + AWS secret store ARN for database credentials. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-awssecretstorearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRelationalDatabaseConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRelationalDatabaseConfig.ps1 index 52f665d2c..bfcee95d7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRelationalDatabaseConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRelationalDatabaseConfig.ps1 @@ -1,21 +1,27 @@ function Add-VSAppSyncDataSourceRelationalDatabaseConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.RelationalDatabaseConfig resource property to the template. + Adds an AWS::AppSync::DataSource.RelationalDatabaseConfig resource property to the template. Use the RelationalDatabaseConfig property type to specify RelationalDatabaseConfig for an AWS AppSync data source. .DESCRIPTION Adds an AWS::AppSync::DataSource.RelationalDatabaseConfig resource property to the template. +Use the RelationalDatabaseConfig property type to specify RelationalDatabaseConfig for an AWS AppSync data source. +RelationalDatabaseConfig is a property of the AWS::AppSync::DataSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html .PARAMETER RdsHttpEndpointConfig + Information about the Amazon RDS resource. + Type: RdsHttpEndpointConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html#cfn-appsync-datasource-relationaldatabaseconfig-rdshttpendpointconfig UpdateType: Mutable .PARAMETER RelationalDatabaseSourceType + The type of relational data source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html#cfn-appsync-datasource-relationaldatabaseconfig-relationaldatabasesourcetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProvider.ps1 index 8288227f8..59859d400 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProvider.ps1 @@ -1,26 +1,32 @@ function Add-VSAppSyncGraphQLApiAdditionalAuthenticationProvider { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.AdditionalAuthenticationProvider resource property to the template. + Adds an AWS::AppSync::GraphQLApi.AdditionalAuthenticationProvider resource property to the template. Describes an additional authentication provider. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.AdditionalAuthenticationProvider resource property to the template. - +Describes an additional authentication provider. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html .PARAMETER OpenIDConnectConfig + The OpenID Connect configuration. + Type: OpenIDConnectConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html#cfn-appsync-graphqlapi-additionalauthenticationprovider-openidconnectconfig UpdateType: Mutable .PARAMETER UserPoolConfig + The Amazon Cognito user pool configuration. + Type: CognitoUserPoolConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html#cfn-appsync-graphqlapi-additionalauthenticationprovider-userpoolconfig UpdateType: Mutable .PARAMETER AuthenticationType + The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html#cfn-appsync-graphqlapi-additionalauthenticationprovider-authenticationtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProviders.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProviders.ps1 index c755df5fd..766a47c5e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProviders.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiAdditionalAuthenticationProviders.ps1 @@ -1,11 +1,17 @@ function Add-VSAppSyncGraphQLApiAdditionalAuthenticationProviders { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.AdditionalAuthenticationProviders resource property to the template. + Adds an AWS::AppSync::GraphQLApi.AdditionalAuthenticationProviders resource property to the template. A list of additional authentication providers for the GraphqlApi API. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.AdditionalAuthenticationProviders resource property to the template. +A list of additional authentication providers for the GraphqlApi API. +*Required*: No + +*Type:* List of AdditionalAuthenticationProvider: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html + +*Update requires:* No interruption .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationproviders.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiCognitoUserPoolConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiCognitoUserPoolConfig.ps1 index 3b92f1663..c67abb36a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiCognitoUserPoolConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiCognitoUserPoolConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSAppSyncGraphQLApiCognitoUserPoolConfig { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.CognitoUserPoolConfig resource property to the template. + Adds an AWS::AppSync::GraphQLApi.CognitoUserPoolConfig resource property to the template. Describes an Amazon Cognito user pool configuration. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.CognitoUserPoolConfig resource property to the template. - +Describes an Amazon Cognito user pool configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html .PARAMETER AppIdClientRegex + A regular expression for validating the incoming Amazon Cognito user pool app client ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html#cfn-appsync-graphqlapi-cognitouserpoolconfig-appidclientregex PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId + The user pool ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html#cfn-appsync-graphqlapi-cognitouserpoolconfig-userpoolid PrimitiveType: String UpdateType: Mutable .PARAMETER AwsRegion + The AWS Region in which the user pool was created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html#cfn-appsync-graphqlapi-cognitouserpoolconfig-awsregion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiLogConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiLogConfig.ps1 index f7ed429c6..e79338654 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiLogConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiLogConfig.ps1 @@ -1,26 +1,42 @@ function Add-VSAppSyncGraphQLApiLogConfig { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.LogConfig resource property to the template. + Adds an AWS::AppSync::GraphQLApi.LogConfig resource property to the template. The LogConfig property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for a AWS AppSync GraphQL API. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.LogConfig resource property to the template. +The LogConfig property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for a AWS AppSync GraphQL API. +LogConfig is a property of the AWS::AppSync::GraphQLApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html .PARAMETER CloudWatchLogsRoleArn + The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-cloudwatchlogsrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER ExcludeVerboseContent + Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-excludeverbosecontent PrimitiveType: Boolean UpdateType: Mutable .PARAMETER FieldLogLevel + The field logging level. Values can be NONE, ERROR, or ALL. ++ **NONE**: No field-level logs are captured. ++ **ERROR**: Logs the following information only for the fields that are in error: ++ The error section in the server response. ++ Field-level errors. ++ The generated request/response functions that got resolved for error fields. ++ **ALL**: The following information is logged for all fields in the query: ++ Field-level tracing information. ++ The generated request/response functions that got resolved for each field. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-fieldloglevel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiOpenIDConnectConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiOpenIDConnectConfig.ps1 index 5dcd19cd6..26fb0ea94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiOpenIDConnectConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiOpenIDConnectConfig.ps1 @@ -1,31 +1,41 @@ function Add-VSAppSyncGraphQLApiOpenIDConnectConfig { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.OpenIDConnectConfig resource property to the template. + Adds an AWS::AppSync::GraphQLApi.OpenIDConnectConfig resource property to the template. The OpenIDConnectConfig property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.OpenIDConnectConfig resource property to the template. +The OpenIDConnectConfig property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API. +OpenIDConnectConfig is a property of the AWS::AppSync::GraphQLApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html .PARAMETER Issuer + The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-issuer PrimitiveType: String UpdateType: Mutable .PARAMETER ClientId + The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-clientid PrimitiveType: String UpdateType: Mutable .PARAMETER AuthTTL + The number of milliseconds a token is valid after being authenticated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-authttl PrimitiveType: Double UpdateType: Mutable .PARAMETER IatTTL + The number of milliseconds a token is valid after being issued to a user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-iatttl PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiTags.ps1 index ffc6f8f4d..0cc25bad8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiTags.ps1 @@ -1,11 +1,17 @@ function Add-VSAppSyncGraphQLApiTags { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.Tags resource property to the template. + Adds an AWS::AppSync::GraphQLApi.Tags resource property to the template. An arbitrary set of tags (key-value pairs for this GraphQL API. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.Tags resource property to the template. +An arbitrary set of tags (key-value pairs for this GraphQL API. +*Required:* No + +*Type:* List of Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html + +*Update requires:* No interruption .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-tags.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiUserPoolConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiUserPoolConfig.ps1 index bd9c1d385..ca535d4d0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiUserPoolConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncGraphQLApiUserPoolConfig.ps1 @@ -1,31 +1,41 @@ function Add-VSAppSyncGraphQLApiUserPoolConfig { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi.UserPoolConfig resource property to the template. + Adds an AWS::AppSync::GraphQLApi.UserPoolConfig resource property to the template. The UserPoolConfig property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API. .DESCRIPTION Adds an AWS::AppSync::GraphQLApi.UserPoolConfig resource property to the template. +The UserPoolConfig property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API. +LogConfig is a property of the AWS::AppSync::GraphQLApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html .PARAMETER AppIdClientRegex + A regular expression for validating the incoming Amazon Cognito user pool app client ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-appidclientregex PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId + The user pool ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-userpoolid PrimitiveType: String UpdateType: Mutable .PARAMETER AwsRegion + The AWS Region in which the user pool was created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-awsregion PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultAction + The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-defaultaction PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverPipelineConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverPipelineConfig.ps1 index e9726507f..5c1debcfd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverPipelineConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverPipelineConfig.ps1 @@ -1,16 +1,20 @@ function Add-VSAppSyncResolverPipelineConfig { <# .SYNOPSIS - Adds an AWS::AppSync::Resolver.PipelineConfig resource property to the template. + Adds an AWS::AppSync::Resolver.PipelineConfig resource property to the template. Use the PipelineConfig property type to specify PipelineConfig for an AWS AppSync resolver. .DESCRIPTION Adds an AWS::AppSync::Resolver.PipelineConfig resource property to the template. +Use the PipelineConfig property type to specify PipelineConfig for an AWS AppSync resolver. +PipelineConfig is a property of the AWS::AppSync::Resolver: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-pipelineconfig.html .PARAMETER Functions + A list of Function objects. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-pipelineconfig.html#cfn-appsync-resolver-pipelineconfig-functions diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScalableTargetAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScalableTargetAction.ps1 index c85499c81..536741e55 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScalableTargetAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScalableTargetAction.ps1 @@ -1,21 +1,25 @@ function Add-VSApplicationAutoScalingScalableTargetScalableTargetAction { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalableTarget.ScalableTargetAction resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalableTarget.ScalableTargetAction resource property to the template. ScalableTargetAction is a subproperty of ScheduledAction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html that represents the minimum and maximum capacity for a scheduled action. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalableTarget.ScalableTargetAction resource property to the template. - +ScalableTargetAction is a subproperty of ScheduledAction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html that represents the minimum and maximum capacity for a scheduled action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html .PARAMETER MaxCapacity + The maximum capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html#cfn-applicationautoscaling-scalabletarget-scalabletargetaction-maxcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinCapacity + The minimum capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html#cfn-applicationautoscaling-scalabletarget-scalabletargetaction-mincapacity PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 index a051e6dee..02f34b67e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 @@ -1,36 +1,54 @@ function Add-VSApplicationAutoScalingScalableTargetScheduledAction { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalableTarget.ScheduledAction resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalableTarget.ScheduledAction resource property to the template. ScheduledAction is a property of ScalableTarget: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html that specifies a scheduled action for a scalable target. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalableTarget.ScheduledAction resource property to the template. +ScheduledAction is a property of ScalableTarget: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html that specifies a scheduled action for a scalable target. +For more information, see PutScheduledAction: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScheduledAction.html in the *Application Auto Scaling API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html .PARAMETER EndTime + The date and time that the action is scheduled to end. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-endtime PrimitiveType: Timestamp UpdateType: Mutable .PARAMETER ScalableTargetAction + The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scalabletargetaction Type: ScalableTargetAction UpdateType: Mutable .PARAMETER Schedule + The schedule for this action. The following formats are supported: ++ At expressions - "atyyyy-mm-ddThh:mm:ss" ++ Rate expressions - "ratevalue unit" ++ Cron expressions - "cronfields" +At expressions are useful for one-time schedules. Specify the time, in UTC. +For rate expressions, *value* is a positive integer and *unit* is minute | minutes | hour | hours | day | days. +For more information about cron expressions, see Cron Expressions: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions in the *Amazon CloudWatch Events User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-schedule PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduledActionName + The name of the scheduled action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scheduledactionname PrimitiveType: String UpdateType: Mutable .PARAMETER StartTime + The date and time that the action is scheduled to begin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-starttime PrimitiveType: Timestamp UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetSuspendedState.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetSuspendedState.ps1 index 3067107fb..16e14c824 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetSuspendedState.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetSuspendedState.ps1 @@ -1,26 +1,32 @@ function Add-VSApplicationAutoScalingScalableTargetSuspendedState { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalableTarget.SuspendedState resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalableTarget.SuspendedState resource property to the template. Specifies whether the scaling activities for a scalable target are in a suspended state. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalableTarget.SuspendedState resource property to the template. - +Specifies whether the scaling activities for a scalable target are in a suspended state. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html .PARAMETER DynamicScalingInSuspended + Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html#cfn-applicationautoscaling-scalabletarget-suspendedstate-dynamicscalinginsuspended PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DynamicScalingOutSuspended + Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html#cfn-applicationautoscaling-scalabletarget-suspendedstate-dynamicscalingoutsuspended PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ScheduledScalingSuspended + Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html#cfn-applicationautoscaling-scalabletarget-suspendedstate-scheduledscalingsuspended PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 index d5569c507..8215c78d8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 @@ -1,16 +1,21 @@ function Add-VSApplicationAutoScalingScalingPolicyCustomizedMetricSpecification { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy.CustomizedMetricSpecification resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy.CustomizedMetricSpecification resource property to the template. CustomizedMetricSpecification is a subproperty of TargetTrackingScalingPolicyConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html that configures a customized metric for a target tracking scaling policy to use with Application Auto Scaling. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalingPolicy.CustomizedMetricSpecification resource property to the template. +CustomizedMetricSpecification is a subproperty of TargetTrackingScalingPolicyConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html that configures a customized metric for a target tracking scaling policy to use with Application Auto Scaling. +For more information, see CustomizedMetricSpecification: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_CustomizedMetricSpecification.html in the *Application Auto Scaling API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html .PARAMETER Dimensions + The dimensions of the metric. +Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-dimensions DuplicatesAllowed: False ItemType: MetricDimension @@ -18,21 +23,29 @@ function Add-VSApplicationAutoScalingScalingPolicyCustomizedMetricSpecification UpdateType: Mutable .PARAMETER MetricName + The name of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER Statistic + The statistic of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Unit + The unit of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyMetricDimension.ps1 index 813360cef..07b30b039 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyMetricDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSApplicationAutoScalingScalingPolicyMetricDimension { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy.MetricDimension resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy.MetricDimension resource property to the template. MetricDimension is a subproperty of CustomizedMetricSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html that specifies the dimensions of a metric for a target tracking scaling policy. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalingPolicy.MetricDimension resource property to the template. - +MetricDimension is a subproperty of CustomizedMetricSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html that specifies the dimensions of a metric for a target tracking scaling policy. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html .PARAMETER Name + The name of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html#cfn-applicationautoscaling-scalingpolicy-metricdimension-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html#cfn-applicationautoscaling-scalingpolicy-metricdimension-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 index 3d99d6331..9bdfcfb66 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 @@ -1,21 +1,30 @@ function Add-VSApplicationAutoScalingScalingPolicyPredefinedMetricSpecification { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy.PredefinedMetricSpecification resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy.PredefinedMetricSpecification resource property to the template. PredefinedMetricSpecification is a subproperty of TargetTrackingScalingPolicyConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html that configures a predefined metric for a target tracking scaling policy to use with Application Auto Scaling. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalingPolicy.PredefinedMetricSpecification resource property to the template. +PredefinedMetricSpecification is a subproperty of TargetTrackingScalingPolicyConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html that configures a predefined metric for a target tracking scaling policy to use with Application Auto Scaling. +For more information, see PredefinedMetricSpecification: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html in the *Application Auto Scaling API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html .PARAMETER PredefinedMetricType + The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceLabel + Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet request or ECS service. +The format is app///targetgroup//, where: ++ app// is the final portion of the load balancer ARN ++ targetgroup// is the final portion of the target group ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepAdjustment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepAdjustment.ps1 index 1b35d564d..4ba89cdcb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepAdjustment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepAdjustment.ps1 @@ -1,26 +1,42 @@ function Add-VSApplicationAutoScalingScalingPolicyStepAdjustment { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment resource property to the template. StepAdjustment is a subproperty of StepScalingPolicyConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html that represents a step adjustment for a step scaling policy. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment resource property to the template. +StepAdjustment is a subproperty of StepScalingPolicyConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html that represents a step adjustment for a step scaling policy. +For the following examples, suppose that you have an alarm with a breach threshold of 50: + ++ To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. + ++ To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. + +For more information, see Step Adjustments: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps in the *Application Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html .PARAMETER MetricIntervalLowerBound + The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive the metric must be greater than or equal to the threshold plus the lower bound. Otherwise, it is exclusive the metric must be greater than the threshold plus the lower bound. A null value indicates negative infinity. +You must specify at least one upper or lower bound. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment-metricintervallowerbound PrimitiveType: Double UpdateType: Mutable .PARAMETER MetricIntervalUpperBound + The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive the metric must be less than the threshold plus the upper bound. Otherwise, it is inclusive the metric must be less than or equal to the threshold plus the upper bound. A null value indicates positive infinity. +You must specify at least one upper or lower bound. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment-metricintervalupperbound PrimitiveType: Double UpdateType: Mutable .PARAMETER ScalingAdjustment + The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property either an absolute number or a percentage. A positive value adds to the current capacity and a negative number subtracts from the current capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment-scalingadjustment PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 index bf54ec355..c118fef8c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 @@ -1,36 +1,51 @@ function Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration resource property to the template. StepScalingPolicyConfiguration is a property of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html that specifies a step scaling policy configuration to use with Application Auto Scaling. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration resource property to the template. +StepScalingPolicyConfiguration is a property of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html that specifies a step scaling policy configuration to use with Application Auto Scaling. +For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html in the *Application Auto Scaling API Reference*. For more information about step scaling policies, see Step Scaling Policies: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html in the *Application Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html .PARAMETER AdjustmentType + Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-adjustmenttype PrimitiveType: String UpdateType: Mutable .PARAMETER Cooldown + The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events. +For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously but not excessively scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count. +For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-cooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER MetricAggregationType + The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-metricaggregationtype PrimitiveType: String UpdateType: Mutable .PARAMETER MinAdjustmentMagnitude + The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount. +For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-minadjustmentmagnitude PrimitiveType: Integer UpdateType: Mutable .PARAMETER StepAdjustments + A set of adjustments that enable you to scale based on the size of the alarm breach. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustments DuplicatesAllowed: False ItemType: StepAdjustment diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 index a37d8ea93..afd419a46 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 @@ -1,41 +1,57 @@ function Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration resource property to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration resource property to the template. TargetTrackingScalingPolicyConfiguration is a property of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html that specifies a target tracking scaling policy to use with Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value. .DESCRIPTION Adds an AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration resource property to the template. +TargetTrackingScalingPolicyConfiguration is a property of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html that specifies a target tracking scaling policy to use with Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value. +For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html in the *Application Auto Scaling API Reference*. For more information about target tracking scaling policies, see Target Tracking Scaling Policies: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html in the *Application Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html .PARAMETER CustomizedMetricSpecification + A customized metric. You can specify either a predefined metric or a customized metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-customizedmetricspecification Type: CustomizedMetricSpecification UpdateType: Mutable .PARAMETER DisableScaleIn + Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-disablescalein PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PredefinedMetricSpecification + A predefined metric. You can specify either a predefined metric or a customized metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-predefinedmetricspecification Type: PredefinedMetricSpecification UpdateType: Mutable .PARAMETER ScaleInCooldown + The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start. +The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleincooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER ScaleOutCooldown + The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. +While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously but not excessively scale out. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleoutcooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER TargetValue + The target value for the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-targetvalue PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLaunchTemplateSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLaunchTemplateSpecification.ps1 index 4f66bffd1..136cd2b80 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLaunchTemplateSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLaunchTemplateSpecification.ps1 @@ -1,26 +1,34 @@ function Add-VSAutoScalingAutoScalingGroupLaunchTemplateSpecification { <# .SYNOPSIS - Adds an AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification resource property to the template. + Adds an AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification resource property to the template. LaunchTemplateSpecification is a property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html that specifies the launch template to use to launch instances. .DESCRIPTION Adds an AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification resource property to the template. +LaunchTemplateSpecification is a property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html that specifies the launch template to use to launch instances. +For information about creating a launch template, see Creating a Launch Template for an Auto Scaling Group: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html .PARAMETER LaunchTemplateId + The ID of the launch template. You must specify either a template ID or a template name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-launchtemplateid PrimitiveType: String UpdateType: Mutable .PARAMETER LaunchTemplateName + The name of the launch template. You must specify either a template name or a template ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-launchtemplatename PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The version number. AWS CloudFormation does not support specifying $Latest, or $Default for the template version number. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLifecycleHookSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLifecycleHookSpecification.ps1 index 7c69405b0..a86a86d4a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLifecycleHookSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupLifecycleHookSpecification.ps1 @@ -1,46 +1,64 @@ function Add-VSAutoScalingAutoScalingGroupLifecycleHookSpecification { <# .SYNOPSIS - Adds an AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification resource property to the template. + Adds an AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification resource property to the template. LifecycleHookSpecification specifies a list of lifecycle hooks for the LifecycleHookSpecificationList property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html. LifecycleHookSpecification defines lifecycle hooks for an Auto Scaling group that specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. .DESCRIPTION Adds an AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification resource property to the template. +LifecycleHookSpecification specifies a list of lifecycle hooks for the LifecycleHookSpecificationList property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html. LifecycleHookSpecification defines lifecycle hooks for an Auto Scaling group that specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. +For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples section of the AWS::AutoScaling::LifecycleHook documentation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html .PARAMETER DefaultResult + The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-defaultresult PrimitiveType: String UpdateType: Mutable .PARAMETER HeartbeatTimeout + The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-heartbeattimeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER LifecycleHookName + The name of the lifecycle hook. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecyclehookname PrimitiveType: String UpdateType: Mutable .PARAMETER LifecycleTransition + The state of the EC2 instance to attach the lifecycle hook to. The valid values are: ++ autoscaling:EC2_INSTANCE_LAUNCHING ++ autoscaling:EC2_INSTANCE_TERMINATING + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecycletransition PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationMetadata + Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationmetadata PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationTargetARN + The Amazon Resource Name ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationtargetarn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. For information about creating this role, see Preparing for Notifications: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html#preparing-for-notification in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 index 2d983e614..b8f061c62 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 @@ -1,21 +1,35 @@ function Add-VSAutoScalingAutoScalingGroupMetricsCollection { <# .SYNOPSIS - Adds an AWS::AutoScaling::AutoScalingGroup.MetricsCollection resource property to the template. + Adds an AWS::AutoScaling::AutoScalingGroup.MetricsCollection resource property to the template. MetricsCollection is a property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. .DESCRIPTION Adds an AWS::AutoScaling::AutoScalingGroup.MetricsCollection resource property to the template. +MetricsCollection is a property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. +For more information, see Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#aws-properties-as-group--examples section of the AWS::AutoScaling::AutoScalingGroup documentation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html .PARAMETER Granularity + The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-granularity PrimitiveType: String UpdateType: Mutable .PARAMETER Metrics + The list of Auto Scaling group metrics to collect. If you specify Granularity and don't specify any metrics, all metrics are enabled. ++ GroupMinSize ++ GroupMaxSize ++ GroupDesiredCapacity ++ GroupInServiceInstances ++ GroupPendingInstances ++ GroupStandbyInstances ++ GroupTerminatingInstances ++ GroupTotalInstances + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-metrics DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 index beaddf09d..061942cc9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 @@ -1,16 +1,25 @@ function Add-VSAutoScalingAutoScalingGroupNotificationConfiguration { <# .SYNOPSIS - Adds an AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration resource property to the template. + Adds an AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration resource property to the template. NotificationConfiguration specifies a list of notification configurations for the NotificationConfigurations property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html. NotificationConfiguration specifies the events that the Amazon EC2 Auto Scaling group sends notifications for. .DESCRIPTION Adds an AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration resource property to the template. +NotificationConfiguration specifies a list of notification configurations for the NotificationConfigurations property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html. NotificationConfiguration specifies the events that the Amazon EC2 Auto Scaling group sends notifications for. +For example snippets, see Auto Scaling Group with Notifications: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html#scenario-as-notification. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html .PARAMETER NotificationTypes + A list of event types that trigger a notification. Event types can include any of the following types: ++ autoscaling:EC2_INSTANCE_LAUNCH ++ autoscaling:EC2_INSTANCE_LAUNCH_ERROR ++ autoscaling:EC2_INSTANCE_TERMINATE ++ autoscaling:EC2_INSTANCE_TERMINATE_ERROR ++ autoscaling:TEST_NOTIFICATION + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html#cfn-as-group-notificationconfigurations-notificationtypes DuplicatesAllowed: True PrimitiveItemType: String @@ -18,6 +27,8 @@ function Add-VSAutoScalingAutoScalingGroupNotificationConfiguration { UpdateType: Mutable .PARAMETER TopicARN + The Amazon Resource Name ARN of the Amazon Simple Notification Service Amazon SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html#cfn-autoscaling-autoscalinggroup-notificationconfigurations-topicarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupTagProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupTagProperty.ps1 index ad6d465be..61a1bdfe0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupTagProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupTagProperty.ps1 @@ -1,26 +1,42 @@ function Add-VSAutoScalingAutoScalingGroupTagProperty { <# .SYNOPSIS - Adds an AWS::AutoScaling::AutoScalingGroup.TagProperty resource property to the template. + Adds an AWS::AutoScaling::AutoScalingGroup.TagProperty resource property to the template. TagProperty specifies a list of tags for the Tag property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html. TagProperty adds tags to all associated instances in an Amazon EC2 Auto Scaling group. .DESCRIPTION Adds an AWS::AutoScaling::AutoScalingGroup.TagProperty resource property to the template. +TagProperty specifies a list of tags for the Tag property of AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html. TagProperty adds tags to all associated instances in an Amazon EC2 Auto Scaling group. +For more information, see Tagging Auto Scaling Groups and Instances: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#aws-properties-as-group--examples section of the AWS::AutoScaling::AutoScalingGroup documentation. + +AWS CloudFormation adds the following tags to all Auto Scaling groups and associated instances: + ++ aws:cloudformation:stack-name + ++ aws:cloudformation:stack-id + ++ aws:cloudformation:logical-id .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html .PARAMETER Key + The tag key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-Key PrimitiveType: String UpdateType: Mutable .PARAMETER PropagateAtLaunch + Set to true if you want AWS CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to false if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-PropagateAtLaunch PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Value + The tag value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-Value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDevice.ps1 index 3d1fc93ed..07215fc49 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDevice.ps1 @@ -1,41 +1,63 @@ function Add-VSAutoScalingLaunchConfigurationBlockDevice { <# .SYNOPSIS - Adds an AWS::AutoScaling::LaunchConfiguration.BlockDevice resource property to the template. + Adds an AWS::AutoScaling::LaunchConfiguration.BlockDevice resource property to the template. BlockDevice is a subproperty of BlockDeviceMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html that describes an Amazon EBS volume. .DESCRIPTION Adds an AWS::AutoScaling::LaunchConfiguration.BlockDevice resource property to the template. +BlockDevice is a subproperty of BlockDeviceMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html that describes an Amazon EBS volume. +For Amazon EC2 Auto Scaling EBS Block Device snippets, see Auto Scaling Launch Configuration Resource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html#scenario-as-launch-config. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html .PARAMETER DeleteOnTermination + Indicates whether to delete the volume when the instance is terminated. For Amazon EC2 Auto Scaling, the default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-deleteonterm PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Encrypted + Specifies whether the EBS volume is encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances. If your AMI uses encrypted volumes, you can also only launch it on supported instance types. +If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK. +Enabling encryption by default: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS to provision for the volume. The maximum ratio of IOPS to volume size in GiB is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon EC2 User Guide for Linux Instances*. +If the volume type is io1, this property is required. Not used with standard, gp2, st1, or sc1 volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotId + The snapshot ID of the volume to use. +You must specify either a VolumeSize or a SnapshotId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-snapshotid PrimitiveType: String UpdateType: Mutable .PARAMETER VolumeSize + The volume size, in Gibibytes GiB. +This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. +If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size. +You must specify either a VolumeSize or a SnapshotId. If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon EC2 User Guide for Linux Instances*. +Valid values: standard | io1 | gp2 | st1 | sc1 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 index 7b8f722e5..09c25d1a9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 @@ -1,31 +1,45 @@ function Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping { <# .SYNOPSIS - Adds an AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping resource property to the template. + Adds an AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping resource property to the template. BlockDeviceMapping is a property of LaunchConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html that describes a block device mapping for an Amazon EC2 Auto Scaling group. .DESCRIPTION Adds an AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping resource property to the template. +BlockDeviceMapping is a property of LaunchConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html that describes a block device mapping for an Amazon EC2 Auto Scaling group. +Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. + +For more information, see Example Block Device Mapping: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#block-device-mapping-ex in the *Amazon EC2 User Guide for Linux Instances*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html .PARAMETER DeviceName + The device name exposed to the EC2 instance for example, /dev/sdh or xvdh. For more information, see Device Naming on Linux Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-devicename PrimitiveType: String UpdateType: Mutable .PARAMETER Ebs + The information about the Amazon EBS volume. +You can specify either VirtualName or Ebs, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-ebs Type: BlockDevice UpdateType: Mutable .PARAMETER NoDevice + Suppresses the device mapping. If this property is set to true for the root device, the instance might fail the Amazon EC2 health check. Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-nodevice PrimitiveType: Boolean UpdateType: Mutable .PARAMETER VirtualName + The name of the virtual device. The name must be in the form ephemeral*X* where *X* is a number starting from zero 0, for example, ephemeral0. +You can specify either VirtualName or Ebs, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-virtualname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanApplicationSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanApplicationSource.ps1 index 19d45e65e..bc8f546ab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanApplicationSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanApplicationSource.ps1 @@ -1,21 +1,25 @@ function Add-VSAutoScalingPlansScalingPlanApplicationSource { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.ApplicationSource resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.ApplicationSource resource property to the template. ApplicationSource is a property of ScalingPlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html that specifies the application source to use with AWS Auto Scaling. You can create one scaling plan per application source. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.ApplicationSource resource property to the template. - +ApplicationSource is a property of ScalingPlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html that specifies the application source to use with AWS Auto Scaling. You can create one scaling plan per application source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html .PARAMETER CloudFormationStackARN + The Amazon Resource Name ARN of a CloudFormation stack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-cloudformationstackarn PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters + A set of tags up to 50. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-tagfilters ItemType: TagFilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedLoadMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedLoadMetricSpecification.ps1 index 58a525eb9..8fb336503 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedLoadMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedLoadMetricSpecification.ps1 @@ -1,37 +1,59 @@ function Add-VSAutoScalingPlansScalingPlanCustomizedLoadMetricSpecification { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification resource property to the template. CustomizedLoadMetricSpecification is a subproperty of ScalingInstruction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html that specifies a customized load metric for predictive scaling to use with AWS Auto Scaling. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification resource property to the template. +CustomizedLoadMetricSpecification is a subproperty of ScalingInstruction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html that specifies a customized load metric for predictive scaling to use with AWS Auto Scaling. +For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. + +When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group. + +If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes. + +For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html in the *Amazon CloudWatch User Guide*. + +After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource in the *AWS Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html .PARAMETER MetricName + The name of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Statistic + The statistic of the metric. +*Allowed Values*: Sum + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Dimensions + The dimensions of the metric. +Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-dimensions ItemType: MetricDimension UpdateType: Mutable .PARAMETER Unit + The unit of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-unit PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-namespace PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedScalingMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedScalingMetricSpecification.ps1 index 2fcf7b779..038dbac44 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedScalingMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanCustomizedScalingMetricSpecification.ps1 @@ -1,37 +1,56 @@ function Add-VSAutoScalingPlansScalingPlanCustomizedScalingMetricSpecification { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification resource property to the template. CustomizedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html that specifies a customized scaling metric for a target tracking configuration to use with AWS Auto Scaling. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification resource property to the template. +CustomizedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html that specifies a customized scaling metric for a target tracking configuration to use with AWS Auto Scaling. +To create your customized scaling metric specification: + ++ Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html in the *Amazon CloudWatch User Guide*. + ++ Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases. + +For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html in the *Amazon CloudWatch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html .PARAMETER MetricName + The name of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Statistic + The statistic of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Dimensions + The dimensions of the metric. +Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions ItemType: MetricDimension UpdateType: Mutable .PARAMETER Unit + The unit of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanMetricDimension.ps1 index 6f5a1e025..f0b054049 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanMetricDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSAutoScalingPlansScalingPlanMetricDimension { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.MetricDimension resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.MetricDimension resource property to the template. MetricDimension is a subproperty of CustomizedScalingMetricSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html that specifies a dimension for a customized metric to use with AWS Auto Scaling. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.MetricDimension resource property to the template. - +MetricDimension is a subproperty of CustomizedScalingMetricSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html that specifies a dimension for a customized metric to use with AWS Auto Scaling. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html .PARAMETER Value + The value of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedLoadMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedLoadMetricSpecification.ps1 index 7e8c04c4d..ed1a4c787 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedLoadMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedLoadMetricSpecification.ps1 @@ -1,21 +1,30 @@ function Add-VSAutoScalingPlansScalingPlanPredefinedLoadMetricSpecification { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification resource property to the template. PredefinedLoadMetricSpecification is a subproperty of ScalingInstruction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html that specifies a predefined load metric for predictive scaling to use with AWS Auto Scaling. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification resource property to the template. +PredefinedLoadMetricSpecification is a subproperty of ScalingInstruction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html that specifies a predefined load metric for predictive scaling to use with AWS Auto Scaling. +After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource in the *AWS Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html .PARAMETER PredefinedLoadMetricType + The metric type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-predefinedloadmetrictype PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceLabel + Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group. +The format is app///targetgroup//, where: ++ app// is the final portion of the load balancer ARN. ++ targetgroup// is the final portion of the target group ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-resourcelabel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedScalingMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedScalingMetricSpecification.ps1 index 9e6f96363..cf241031e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedScalingMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanPredefinedScalingMetricSpecification.ps1 @@ -1,21 +1,28 @@ function Add-VSAutoScalingPlansScalingPlanPredefinedScalingMetricSpecification { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification resource property to the template. PredefinedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html that specifies a customized scaling metric for a target tracking configuration to use with AWS Auto Scaling. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification resource property to the template. - +PredefinedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html that specifies a customized scaling metric for a target tracking configuration to use with AWS Auto Scaling. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html .PARAMETER ResourceLabel + Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service. +The format is app///targetgroup//, where: ++ app// is the final portion of the load balancer ARN. ++ targetgroup// is the final portion of the target group ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-resourcelabel PrimitiveType: String UpdateType: Mutable .PARAMETER PredefinedScalingMetricType + The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-predefinedscalingmetrictype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanScalingInstruction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanScalingInstruction.ps1 index 4efcacfb2..075078cba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanScalingInstruction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanScalingInstruction.ps1 @@ -1,82 +1,143 @@ function Add-VSAutoScalingPlansScalingPlanScalingInstruction { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction resource property to the template. ScalingInstruction is a property of ScalingPlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html that specifies the scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction resource property to the template. +ScalingInstruction is a property of ScalingPlan: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html that specifies the scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource. +AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified. + +AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of properties, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only, and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast. + +**Important** + +We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto Scaling: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html in the *AWS Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html .PARAMETER DisableDynamicScaling + Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. +The default is enabled false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-disabledynamicscaling PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ServiceNamespace + The namespace of the AWS service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-servicenamespace PrimitiveType: String UpdateType: Mutable .PARAMETER PredictiveScalingMaxCapacityBehavior + Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity. +The following are possible values: ++ SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit. ++ SetMaxCapacityToForecastCapacity - AWS Auto Scaling can scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity. ++ SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling can scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs. +Valid only when configuring predictive scaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybehavior PrimitiveType: String UpdateType: Mutable .PARAMETER ScalableDimension + The scalable dimension associated with the resource. ++ autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ++ ecs:service:DesiredCount - The desired task count of an ECS service. ++ ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. ++ dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. ++ dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. ++ dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. ++ dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. ++ rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalabledimension PrimitiveType: String UpdateType: Mutable .PARAMETER ScalingPolicyUpdateBehavior + Controls whether your scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. +Valid only when configuring dynamic scaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalingpolicyupdatebehavior PrimitiveType: String UpdateType: Mutable .PARAMETER MinCapacity + The minimum capacity of the resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-mincapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER TargetTrackingConfigurations + The target tracking configurations up to 10. Each of these structures must specify a unique scaling metric and a target value for the metric. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-targettrackingconfigurations ItemType: TargetTrackingConfiguration UpdateType: Mutable .PARAMETER PredictiveScalingMaxCapacityBuffer + The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. With a 10 percent buffer, if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. +Valid only when configuring predictive scaling. Required if **PredictiveScalingMaxCapacityBehavior** is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise. +The range is 1-100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybuffer PrimitiveType: Integer UpdateType: Mutable .PARAMETER CustomizedLoadMetricSpecification + The customized load metric to use for predictive scaling. This property or a **PredefinedLoadMetricSpecification** is required when configuring predictive scaling, and cannot be used otherwise. + Type: CustomizedLoadMetricSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-customizedloadmetricspecification UpdateType: Mutable .PARAMETER PredefinedLoadMetricSpecification + The predefined load metric to use for predictive scaling. This property or a **CustomizedLoadMetricSpecification** is required when configuring predictive scaling, and cannot be used otherwise. + Type: PredefinedLoadMetricSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predefinedloadmetricspecification UpdateType: Mutable .PARAMETER ResourceId + The ID of the resource. This string consists of the resource type and unique identifier. ++ Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ++ ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. ++ Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. ++ DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. ++ DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. ++ Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-resourceid PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduledActionBufferTime + The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. +The value must be less than the forecast interval duration of 3600 seconds 60 minutes. The default is 300 seconds. +Valid only when configuring predictive scaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scheduledactionbuffertime PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaxCapacity + The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for **PredictiveScalingMaxCapacityBehavior**. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-maxcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER PredictiveScalingMode + The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTagFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTagFilter.ps1 index 4ff8e8fb4..ae1b80c8d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTagFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTagFilter.ps1 @@ -1,22 +1,26 @@ function Add-VSAutoScalingPlansScalingPlanTagFilter { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.TagFilter resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.TagFilter resource property to the template. TagFilter is a subproperty of ApplicationSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html that specifies a tag for an application source to use with AWS Auto Scaling. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.TagFilter resource property to the template. - +TagFilter is a subproperty of ApplicationSource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html that specifies a tag for an application source to use with AWS Auto Scaling. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html .PARAMETER Values + The tag values 0 to 20. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-values UpdateType: Mutable .PARAMETER Key + The tag key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTargetTrackingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTargetTrackingConfiguration.ps1 index fd710c719..7ff9ffcdf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTargetTrackingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingPlansScalingPlanTargetTrackingConfiguration.ps1 @@ -1,46 +1,61 @@ function Add-VSAutoScalingPlansScalingPlanTargetTrackingConfiguration { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration resource property to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration resource property to the template. TargetTrackingConfiguration is a subproperty of ScalingInstruction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html that specifies a target tracking configuration to use with AWS Auto Scaling. .DESCRIPTION Adds an AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration resource property to the template. - +TargetTrackingConfiguration is a subproperty of ScalingInstruction: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html that specifies a target tracking configuration to use with AWS Auto Scaling. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html .PARAMETER ScaleOutCooldown + The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleoutcooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER TargetValue + The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 Base 10 or 2e-360 to 2e360 Base 2. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-targetvalue PrimitiveType: Double UpdateType: Mutable .PARAMETER PredefinedScalingMetricSpecification + A predefined metric. You can specify either a predefined metric or a customized metric. + Type: PredefinedScalingMetricSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-predefinedscalingmetricspecification UpdateType: Mutable .PARAMETER DisableScaleIn + Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. +The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-disablescalein PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ScaleInCooldown + The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleincooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER EstimatedInstanceWarmup + The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-estimatedinstancewarmup PrimitiveType: Integer UpdateType: Mutable .PARAMETER CustomizedScalingMetricSpecification + A customized metric. You can specify either a predefined metric or a customized metric. + Type: CustomizedScalingMetricSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-customizedscalingmetricspecification UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 index ff291409c..eefb60aba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyCustomizedMetricSpecification.ps1 @@ -1,16 +1,21 @@ function Add-VSAutoScalingScalingPolicyCustomizedMetricSpecification { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification resource property to the template. + Adds an AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification resource property to the template. CustomizedMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html that configures a customized metric for a target tracking policy to use with Amazon EC2 Auto Scaling. .DESCRIPTION Adds an AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification resource property to the template. +CustomizedMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html that configures a customized metric for a target tracking policy to use with Amazon EC2 Auto Scaling. +For more information, see CustomizedMetricSpecification: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CustomizedMetricSpecification.html in the *Amazon EC2 Auto Scaling API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html .PARAMETER Dimensions + The dimensions of the metric. +Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-dimensions DuplicatesAllowed: False ItemType: MetricDimension @@ -18,21 +23,29 @@ function Add-VSAutoScalingScalingPolicyCustomizedMetricSpecification { UpdateType: Mutable .PARAMETER MetricName + The name of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER Statistic + The statistic of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Unit + The unit of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyMetricDimension.ps1 index 353ef38af..bd081b49b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyMetricDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSAutoScalingScalingPolicyMetricDimension { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScalingPolicy.MetricDimension resource property to the template. + Adds an AWS::AutoScaling::ScalingPolicy.MetricDimension resource property to the template. MetricDimension is a subproperty of CustomizedMetricSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html that specifies the dimensions of a metric for a target tracking scaling policy. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed. .DESCRIPTION Adds an AWS::AutoScaling::ScalingPolicy.MetricDimension resource property to the template. - +MetricDimension is a subproperty of CustomizedMetricSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html that specifies the dimensions of a metric for a target tracking scaling policy. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. Duplicate dimensions are not allowed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html .PARAMETER Name + The name of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html#cfn-autoscaling-scalingpolicy-metricdimension-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html#cfn-autoscaling-scalingpolicy-metricdimension-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 index ca3666dd2..b05cd52cb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 @@ -1,21 +1,30 @@ function Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification resource property to the template. + Adds an AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification resource property to the template. PredefinedMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html that configures a predefined metric for a target tracking policy to use with Amazon EC2 Auto Scaling. .DESCRIPTION Adds an AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification resource property to the template. - +PredefinedMetricSpecification is a subproperty of TargetTrackingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html that configures a predefined metric for a target tracking policy to use with Amazon EC2 Auto Scaling. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html .PARAMETER PredefinedMetricType + The metric type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceLabel + Identifies the resource associated with the metric type. The following predefined metrics are available: ++ ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. ++ ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group. ++ ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group. ++ ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group. +For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the property must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the property must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyStepAdjustment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyStepAdjustment.ps1 index 70baa4053..106d28cd7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyStepAdjustment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyStepAdjustment.ps1 @@ -1,26 +1,42 @@ function Add-VSAutoScalingScalingPolicyStepAdjustment { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScalingPolicy.StepAdjustment resource property to the template. + Adds an AWS::AutoScaling::ScalingPolicy.StepAdjustment resource property to the template. StepAdjustments is a subproperty of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html that represents a step adjustment for a step scaling policy. .DESCRIPTION Adds an AWS::AutoScaling::ScalingPolicy.StepAdjustment resource property to the template. +StepAdjustments is a subproperty of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html that represents a step adjustment for a step scaling policy. +For the following examples, suppose that you have an alarm with a breach threshold of 50: + ++ To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. + ++ To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. + +For more information, see Step Adjustments: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html .PARAMETER MetricIntervalLowerBound + The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive the metric must be greater than or equal to the threshold plus the lower bound. Otherwise, it is exclusive the metric must be greater than the threshold plus the lower bound. A null value indicates negative infinity. +You must specify at least one upper or lower bound. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html#cfn-autoscaling-scalingpolicy-stepadjustment-metricintervallowerbound PrimitiveType: Double UpdateType: Mutable .PARAMETER MetricIntervalUpperBound + The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive the metric must be less than the threshold plus the upper bound. Otherwise, it is inclusive the metric must be less than or equal to the threshold plus the upper bound. A null value indicates positive infinity. +You must specify at least one upper or lower bound. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html#cfn-autoscaling-scalingpolicy-stepadjustment-metricintervalupperbound PrimitiveType: Double UpdateType: Mutable .PARAMETER ScalingAdjustment + The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property either an absolute number or a percentage. A positive value adds to the current capacity and a negative number subtracts from the current capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html#cfn-autoscaling-scalingpolicy-stepadjustment-scalingadjustment PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyTargetTrackingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyTargetTrackingConfiguration.ps1 index 068dd6bfb..3297ffac4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyTargetTrackingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyTargetTrackingConfiguration.ps1 @@ -1,31 +1,41 @@ function Add-VSAutoScalingScalingPolicyTargetTrackingConfiguration { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration resource property to the template. + Adds an AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration resource property to the template. TargetTrackingConfiguration is a subproperty of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html that specifies a target tracking scaling policy to use with Amazon EC2 Auto Scaling. .DESCRIPTION Adds an AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration resource property to the template. +TargetTrackingConfiguration is a subproperty of ScalingPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html that specifies a target tracking scaling policy to use with Amazon EC2 Auto Scaling. +For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PutScalingPolicy.html in the *Amazon EC2 Auto Scaling API Reference*. For more information about scaling policies, see Dynamic Scaling: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html .PARAMETER CustomizedMetricSpecification + A customized metric. You must specify either a predefined metric or a customized metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-customizedmetricspecification Type: CustomizedMetricSpecification UpdateType: Mutable .PARAMETER DisableScaleIn + Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-disablescalein PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PredefinedMetricSpecification + A predefined metric. You must specify either a predefined metric or a customized metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-predefinedmetricspecification Type: PredefinedMetricSpecification UpdateType: Mutable .PARAMETER TargetValue + The target value for the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-targetvalue PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupPlanResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupPlanResourceType.ps1 index 922f6e73d..348661aeb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupPlanResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupPlanResourceType.ps1 @@ -1,21 +1,25 @@ function Add-VSBackupBackupPlanBackupPlanResourceType { <# .SYNOPSIS - Adds an AWS::Backup::BackupPlan.BackupPlanResourceType resource property to the template. + Adds an AWS::Backup::BackupPlan.BackupPlanResourceType resource property to the template. Specifies an object containing properties used to create a backup plan. .DESCRIPTION Adds an AWS::Backup::BackupPlan.BackupPlanResourceType resource property to the template. - +Specifies an object containing properties used to create a backup plan. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html .PARAMETER BackupPlanName + The display name of a backup plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-backupplanname PrimitiveType: String UpdateType: Mutable .PARAMETER BackupPlanRule + An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-backupplanrule ItemType: BackupRuleResourceType diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 index e0577d9d6..d298a94d4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 @@ -1,52 +1,68 @@ function Add-VSBackupBackupPlanBackupRuleResourceType { <# .SYNOPSIS - Adds an AWS::Backup::BackupPlan.BackupRuleResourceType resource property to the template. + Adds an AWS::Backup::BackupPlan.BackupRuleResourceType resource property to the template. Specifies an object containing properties used to schedule a task to back up a selection of resources. .DESCRIPTION Adds an AWS::Backup::BackupPlan.BackupRuleResourceType resource property to the template. - +Specifies an object containing properties used to schedule a task to back up a selection of resources. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html .PARAMETER CompletionWindowMinutes + A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-completionwindowminutes PrimitiveType: Double UpdateType: Mutable .PARAMETER ScheduleExpression + A CRON expression specifying when AWS Backup initiates a backup job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpression PrimitiveType: String UpdateType: Mutable .PARAMETER RecoveryPointTags + To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-recoverypointtags PrimitiveType: Json UpdateType: Mutable .PARAMETER CopyActions + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-copyactions ItemType: CopyActionResourceType UpdateType: Mutable .PARAMETER Lifecycle + The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. + Type: LifecycleResourceType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-lifecycle UpdateType: Mutable .PARAMETER TargetBackupVault + The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-targetbackupvault PrimitiveType: String UpdateType: Mutable .PARAMETER StartWindowMinutes + An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-startwindowminutes PrimitiveType: Double UpdateType: Mutable .PARAMETER RuleName + An optional display name for a backup rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-rulename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanLifecycleResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanLifecycleResourceType.ps1 index d813644d3..42dbe2e74 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanLifecycleResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanLifecycleResourceType.ps1 @@ -1,21 +1,25 @@ function Add-VSBackupBackupPlanLifecycleResourceType { <# .SYNOPSIS - Adds an AWS::Backup::BackupPlan.LifecycleResourceType resource property to the template. + Adds an AWS::Backup::BackupPlan.LifecycleResourceType resource property to the template. Specifies an object containing an array of Transition objects that determine how long in days before a recovery point transitions to cold storage or is deleted. .DESCRIPTION Adds an AWS::Backup::BackupPlan.LifecycleResourceType resource property to the template. - +Specifies an object containing an array of Transition objects that determine how long in days before a recovery point transitions to cold storage or is deleted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html .PARAMETER DeleteAfterDays + Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-deleteafterdays PrimitiveType: Double UpdateType: Mutable .PARAMETER MoveToColdStorageAfterDays + Specifies the number of days after creation that a recovery point is moved to cold storage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-movetocoldstorageafterdays PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionBackupSelectionResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionBackupSelectionResourceType.ps1 index b0ecbc684..0d9ae6f3f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionBackupSelectionResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionBackupSelectionResourceType.ps1 @@ -1,32 +1,40 @@ function Add-VSBackupBackupSelectionBackupSelectionResourceType { <# .SYNOPSIS - Adds an AWS::Backup::BackupSelection.BackupSelectionResourceType resource property to the template. + Adds an AWS::Backup::BackupSelection.BackupSelectionResourceType resource property to the template. Specifies an object containing properties used to assign a set of resources to a backup plan. .DESCRIPTION Adds an AWS::Backup::BackupSelection.BackupSelectionResourceType resource property to the template. - +Specifies an object containing properties used to assign a set of resources to a backup plan. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html .PARAMETER ListOfTags + An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-listoftags ItemType: ConditionResourceType UpdateType: Mutable .PARAMETER SelectionName + The display name of a resource selection document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-selectionname PrimitiveType: String UpdateType: Mutable .PARAMETER IamRoleArn + The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-iamrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Resources + An array of strings that either contain Amazon Resource Names ARNs or match patterns such as "arn:aws:ec2:us-east-1:123456789012:volume/*" of resources to assign to a backup plan. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-resources diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionConditionResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionConditionResourceType.ps1 index 89dfe3b29..559910f27 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionConditionResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupSelectionConditionResourceType.ps1 @@ -1,26 +1,32 @@ function Add-VSBackupBackupSelectionConditionResourceType { <# .SYNOPSIS - Adds an AWS::Backup::BackupSelection.ConditionResourceType resource property to the template. + Adds an AWS::Backup::BackupSelection.ConditionResourceType resource property to the template. Specifies an object that contains an array of triplets made up of a condition type (such as StringEquals, a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan. .DESCRIPTION Adds an AWS::Backup::BackupSelection.ConditionResourceType resource property to the template. - +Specifies an object that contains an array of triplets made up of a condition type (such as StringEquals, a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html .PARAMETER ConditionValue + The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditionvalue PrimitiveType: String UpdateType: Mutable .PARAMETER ConditionKey + The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditionkey PrimitiveType: String UpdateType: Mutable .PARAMETER ConditionType + An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditiontype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupVaultNotificationObjectType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupVaultNotificationObjectType.ps1 index 0126a7214..31a1d345c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupVaultNotificationObjectType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupVaultNotificationObjectType.ps1 @@ -1,21 +1,25 @@ function Add-VSBackupBackupVaultNotificationObjectType { <# .SYNOPSIS - Adds an AWS::Backup::BackupVault.NotificationObjectType resource property to the template. + Adds an AWS::Backup::BackupVault.NotificationObjectType resource property to the template. Specifies an object containing SNS event notification properties for the target backup vault. .DESCRIPTION Adds an AWS::Backup::BackupVault.NotificationObjectType resource property to the template. - +Specifies an object containing SNS event notification properties for the target backup vault. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html .PARAMETER SNSTopicArn + An ARN that uniquely identifies an Amazon Simple Notification Service Amazon SNS topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html#cfn-backup-backupvault-notificationobjecttype-snstopicarn PrimitiveType: String UpdateType: Mutable .PARAMETER BackupVaultEvents + An array of events that indicate the status of jobs to back up resources to the backup vault. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html#cfn-backup-backupvault-notificationobjecttype-backupvaultevents diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 index 926309301..fd3980a60 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 @@ -1,94 +1,126 @@ function Add-VSBatchComputeEnvironmentComputeResources { <# .SYNOPSIS - Adds an AWS::Batch::ComputeEnvironment.ComputeResources resource property to the template. + Adds an AWS::Batch::ComputeEnvironment.ComputeResources resource property to the template. Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .DESCRIPTION Adds an AWS::Batch::ComputeEnvironment.ComputeResources resource property to the template. - +Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html .PARAMETER SpotIamFleetRole + The Amazon Resource Name ARN of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-spotiamfleetrole PrimitiveType: String UpdateType: Immutable .PARAMETER MaxvCpus + The maximum number of EC2 vCPUs that an environment can reach. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus PrimitiveType: Integer UpdateType: Mutable .PARAMETER BidPercentage + The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest market price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage PrimitiveType: Integer UpdateType: Immutable .PARAMETER SecurityGroupIds + The EC2 security group that is associated with instances launched in the compute environment. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids UpdateType: Immutable .PARAMETER Subnets + The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html in the *Amazon VPC User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets UpdateType: Immutable .PARAMETER Type + The type of compute environment: EC2 or SPOT. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type PrimitiveType: String UpdateType: Immutable .PARAMETER AllocationStrategy + + Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy PrimitiveType: String UpdateType: Immutable .PARAMETER MinvCpus + The minimum number of EC2 vCPUs that an environment should maintain even if the compute environment is DISABLED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus PrimitiveType: Integer UpdateType: Mutable .PARAMETER LaunchTemplate + The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment: https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support: https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html in the *AWS Batch User Guide*. + Type: LaunchTemplateSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate UpdateType: Immutable .PARAMETER ImageId + The Amazon Machine Image AMI ID used for instances launched in the compute environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceRole + The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name ARN of an instance profile. For example, ecsInstanceRole or arn:aws:iam:::instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role: https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceTypes + The instances types that may be launched. You can specify instance families to launch any instance type within those families for example, c4 or p3, or you can specify specific sizes within a family such as c4.8xlarge. You can also choose optimal to pick instance types from the C, M, and R instance families on the fly that match the demand of your job queues. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes UpdateType: Immutable .PARAMETER Ec2KeyPair + The EC2 key pair that is used for instances launched in the compute environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair PrimitiveType: String UpdateType: Immutable .PARAMETER PlacementGroup + The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags PrimitiveType: Json UpdateType: Immutable .PARAMETER DesiredvCpus + The desired number of EC2 vCPUS in the compute environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-desiredvcpus PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentLaunchTemplateSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentLaunchTemplateSpecification.ps1 index 4e3eda843..4e36403e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentLaunchTemplateSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentLaunchTemplateSpecification.ps1 @@ -1,26 +1,33 @@ function Add-VSBatchComputeEnvironmentLaunchTemplateSpecification { <# .SYNOPSIS - Adds an AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification resource property to the template. + Adds an AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification resource property to the template. An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both. .DESCRIPTION Adds an AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification resource property to the template. - +An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html .PARAMETER LaunchTemplateName + The name of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplatename PrimitiveType: String UpdateType: Immutable .PARAMETER Version + The version number of the launch template. +Default: The default version of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchTemplateId + The ID of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplateid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionContainerProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionContainerProperties.ps1 index 80c6a1d1c..1347694bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionContainerProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionContainerProperties.ps1 @@ -1,92 +1,129 @@ function Add-VSBatchJobDefinitionContainerProperties { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.ContainerProperties resource property to the template. + Adds an AWS::Batch::JobDefinition.ContainerProperties resource property to the template. Container properties are used in job definitions to describe the container that is launched as part of a job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.ContainerProperties resource property to the template. - +Container properties are used in job definitions to describe the container that is launched as part of a job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html .PARAMETER User + The user name to use inside the container. This parameter maps to User in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --user option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-user PrimitiveType: String UpdateType: Mutable .PARAMETER Memory + The hard limit in MiB of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --memory option to docker run: https://docs.docker.com/engine/reference/run/. You must specify at least 4 MiB of memory for a job. +If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-memory PrimitiveType: Integer UpdateType: Mutable .PARAMETER Privileged + When this parameter is true, the container is given elevated privileges on the host container instance similar to the root user. This parameter maps to Privileged in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --privileged option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-privileged PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LinuxParameters + Linux-specific modifications that are applied to the container, such as details for device mappings. + Type: LinuxParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-linuxparameters UpdateType: Mutable .PARAMETER JobRoleArn + The Amazon Resource Name ARN of the IAM role that the container can assume for AWS permissions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-jobrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER ReadonlyRootFilesystem + When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --read-only option to docker run. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-readonlyrootfilesystem PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Vcpus + The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --cpu-shares option to docker run: https://docs.docker.com/engine/reference/run/. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-vcpus PrimitiveType: Integer UpdateType: Mutable .PARAMETER Image + The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters uppercase and lowercase, numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the IMAGE parameter of docker run: https://docs.docker.com/engine/reference/run/. ++ Images in Amazon ECR repositories use the full registry and repository URI for example, 012345678910.dkr.ecr..amazonaws.com/. ++ Images in official repositories on Docker Hub use a single name for example, ubuntu or mongo. ++ Images in other repositories on Docker Hub are qualified with an organization name for example, amazon/amazon-ecs-agent. ++ Images in other online repositories are qualified further by a domain name for example, quay.io/assemblyline/ubuntu. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-image PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceRequirements + The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-resourcerequirements ItemType: ResourceRequirement UpdateType: Mutable .PARAMETER MountPoints + The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --volume option to docker run: https://docs.docker.com/engine/reference/run/. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-mountpoints ItemType: MountPoints UpdateType: Mutable .PARAMETER Volumes + A list of data volumes used in a job. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-volumes ItemType: Volumes UpdateType: Mutable .PARAMETER Command + The command that is passed to the container. This parameter maps to Cmd in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the COMMAND parameter to docker run: https://docs.docker.com/engine/reference/run/. For more information, see https://docs.docker.com/engine/reference/builder/#cmd: https://docs.docker.com/engine/reference/builder/#cmd. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-command UpdateType: Mutable .PARAMETER Environment + The environment variables to pass to a container. This parameter maps to Env in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --env option to docker run: https://docs.docker.com/engine/reference/run/. +We do not recommend using plaintext environment variables for sensitive information, such as credential data. +Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-environment ItemType: Environment UpdateType: Mutable .PARAMETER Ulimits + A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --ulimit option to docker run: https://docs.docker.com/engine/reference/run/. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ulimits ItemType: Ulimit UpdateType: Mutable .PARAMETER InstanceType + The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-instancetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionDevice.ps1 index 4e2467a3e..91909b648 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionDevice.ps1 @@ -1,27 +1,33 @@ function Add-VSBatchJobDefinitionDevice { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.Device resource property to the template. + Adds an AWS::Batch::JobDefinition.Device resource property to the template. An object representing a container instance host device. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Device resource property to the template. - +An object representing a container instance host device. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html .PARAMETER HostPath + The path for the device on the host container instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-hostpath PrimitiveType: String UpdateType: Mutable .PARAMETER Permissions + The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-permissions UpdateType: Mutable .PARAMETER ContainerPath + The path inside the container at which to expose the host device. By default the hostPath value is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-containerpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionEnvironment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionEnvironment.ps1 index ee4389166..31b39a4f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionEnvironment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionEnvironment.ps1 @@ -1,21 +1,25 @@ function Add-VSBatchJobDefinitionEnvironment { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.Environment resource property to the template. + Adds an AWS::Batch::JobDefinition.Environment resource property to the template. The Environment property type specifies environment variables to use in a job definition. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Environment resource property to the template. - +The Environment property type specifies environment variables to use in a job definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html .PARAMETER Value + The value of the environment variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the environment variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionLinuxParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionLinuxParameters.ps1 index 8eb1d5035..d71c48363 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionLinuxParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionLinuxParameters.ps1 @@ -1,16 +1,18 @@ function Add-VSBatchJobDefinitionLinuxParameters { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.LinuxParameters resource property to the template. + Adds an AWS::Batch::JobDefinition.LinuxParameters resource property to the template. Linux-specific modifications that are applied to the container, such as details for device mappings. .DESCRIPTION Adds an AWS::Batch::JobDefinition.LinuxParameters resource property to the template. - +Linux-specific modifications that are applied to the container, such as details for device mappings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html .PARAMETER Devices + Any host devices to expose to the container. This parameter maps to Devices in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --device option to docker run: https://docs.docker.com/engine/reference/run/. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-devices ItemType: Device diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionMountPoints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionMountPoints.ps1 index 2e839ce2f..6b9a5f685 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionMountPoints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionMountPoints.ps1 @@ -1,26 +1,32 @@ function Add-VSBatchJobDefinitionMountPoints { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.MountPoints resource property to the template. + Adds an AWS::Batch::JobDefinition.MountPoints resource property to the template. Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container section of the Docker Remote API and the --volume option to docker run. .DESCRIPTION Adds an AWS::Batch::JobDefinition.MountPoints resource property to the template. - +Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container section of the Docker Remote API and the --volume option to docker run. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html .PARAMETER ReadOnly + If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-readonly PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SourceVolume + The name of the volume to mount. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-sourcevolume PrimitiveType: String UpdateType: Mutable .PARAMETER ContainerPath + The path on the container at which to mount the host volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-containerpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeProperties.ps1 index 6c07c95ea..1fc59da3b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeProperties.ps1 @@ -1,27 +1,33 @@ function Add-VSBatchJobDefinitionNodeProperties { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.NodeProperties resource property to the template. + Adds an AWS::Batch::JobDefinition.NodeProperties resource property to the template. An object representing the node properties of a multi-node parallel job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.NodeProperties resource property to the template. - +An object representing the node properties of a multi-node parallel job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html .PARAMETER MainNode + Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-mainnode PrimitiveType: Integer UpdateType: Mutable .PARAMETER NodeRangeProperties + A list of node ranges and their properties associated with a multi-node parallel job. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-noderangeproperties ItemType: NodeRangeProperty UpdateType: Mutable .PARAMETER NumNodes + The number of nodes associated with a multi-node parallel job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-numnodes PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeRangeProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeRangeProperty.ps1 index cd2267dbd..d4ca6033c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeRangeProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionNodeRangeProperty.ps1 @@ -1,21 +1,25 @@ function Add-VSBatchJobDefinitionNodeRangeProperty { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.NodeRangeProperty resource property to the template. + Adds an AWS::Batch::JobDefinition.NodeRangeProperty resource property to the template. An object representing the properties of the node range for a multi-node parallel job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.NodeRangeProperty resource property to the template. - +An object representing the properties of the node range for a multi-node parallel job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html .PARAMETER Container + The container details for the node range. + Type: ContainerProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-container UpdateType: Mutable .PARAMETER TargetNodes + The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted :n, then 0 is used to start the range. If the ending range value is omitted n:, then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes 0:n. You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-targetnodes PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionResourceRequirement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionResourceRequirement.ps1 index 61f999e30..0dae268ef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionResourceRequirement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionResourceRequirement.ps1 @@ -1,21 +1,25 @@ function Add-VSBatchJobDefinitionResourceRequirement { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.ResourceRequirement resource property to the template. + Adds an AWS::Batch::JobDefinition.ResourceRequirement resource property to the template. The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU. .DESCRIPTION Adds an AWS::Batch::JobDefinition.ResourceRequirement resource property to the template. - +The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html .PARAMETER Type + The type of resource to assign to a container. Currently, the only supported resource type is GPU. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionRetryStrategy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionRetryStrategy.ps1 index 133a7d1cf..3e316baa9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionRetryStrategy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionRetryStrategy.ps1 @@ -1,16 +1,18 @@ function Add-VSBatchJobDefinitionRetryStrategy { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.RetryStrategy resource property to the template. + Adds an AWS::Batch::JobDefinition.RetryStrategy resource property to the template. The retry strategy associated with a job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.RetryStrategy resource property to the template. - +The retry strategy associated with a job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html .PARAMETER Attempts + The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-attempts PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionTimeout.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionTimeout.ps1 index 2408f3e78..74a990589 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionTimeout.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionTimeout.ps1 @@ -1,16 +1,18 @@ function Add-VSBatchJobDefinitionTimeout { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.Timeout resource property to the template. + Adds an AWS::Batch::JobDefinition.Timeout resource property to the template. An object representing a job timeout configuration. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Timeout resource property to the template. - +An object representing a job timeout configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html .PARAMETER AttemptDurationSeconds + The time duration in seconds measured from the job attempt's startedAt timestamp after which AWS Batch terminates your jobs if they have not finished. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html#cfn-batch-jobdefinition-timeout-attemptdurationseconds PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionUlimit.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionUlimit.ps1 index b416356b3..b049bc55e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionUlimit.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionUlimit.ps1 @@ -1,26 +1,32 @@ function Add-VSBatchJobDefinitionUlimit { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.Ulimit resource property to the template. + Adds an AWS::Batch::JobDefinition.Ulimit resource property to the template. The ulimit settings to pass to the container. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Ulimit resource property to the template. - +The ulimit settings to pass to the container. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html .PARAMETER SoftLimit + The soft limit for the ulimit type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-softlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER HardLimit + The hard limit for the ulimit type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-hardlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + The type of the ulimit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumes.ps1 index 0a505b415..de5ff249b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumes.ps1 @@ -1,21 +1,25 @@ function Add-VSBatchJobDefinitionVolumes { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.Volumes resource property to the template. + Adds an AWS::Batch::JobDefinition.Volumes resource property to the template. A list of volumes associated with the job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Volumes resource property to the template. - +A list of volumes associated with the job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html .PARAMETER Host + The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running. + Type: VolumesHost Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-host UpdateType: Mutable .PARAMETER Name + The name of the volume. Up to 255 letters uppercase and lowercase, numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumesHost.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumesHost.ps1 index 022d8a602..0ac8cb215 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumesHost.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobDefinitionVolumesHost.ps1 @@ -1,16 +1,18 @@ function Add-VSBatchJobDefinitionVolumesHost { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition.VolumesHost resource property to the template. + Adds an AWS::Batch::JobDefinition.VolumesHost resource property to the template. Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running. .DESCRIPTION Adds an AWS::Batch::JobDefinition.VolumesHost resource property to the template. - +Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html .PARAMETER SourcePath + The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html#cfn-batch-jobdefinition-volumeshost-sourcepath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchJobQueueComputeEnvironmentOrder.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchJobQueueComputeEnvironmentOrder.ps1 index 2fbfe1705..249099e31 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchJobQueueComputeEnvironmentOrder.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchJobQueueComputeEnvironmentOrder.ps1 @@ -1,21 +1,25 @@ function Add-VSBatchJobQueueComputeEnvironmentOrder { <# .SYNOPSIS - Adds an AWS::Batch::JobQueue.ComputeEnvironmentOrder resource property to the template. + Adds an AWS::Batch::JobQueue.ComputeEnvironmentOrder resource property to the template. The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. .DESCRIPTION Adds an AWS::Batch::JobQueue.ComputeEnvironmentOrder resource property to the template. - +The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html .PARAMETER ComputeEnvironment + The Amazon Resource Name ARN of the compute environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-computeenvironment PrimitiveType: String UpdateType: Mutable .PARAMETER Order + The order of the compute environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-order PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 index 4569f86b7..34ee29454 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 @@ -1,51 +1,82 @@ function Add-VSBudgetsBudgetBudgetData { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.BudgetData resource property to the template. + Adds an AWS::Budgets::Budget.BudgetData resource property to the template. Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object. .DESCRIPTION Adds an AWS::Budgets::Budget.BudgetData resource property to the template. +Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object. +This is the ARN pattern for a budget: + +arn:aws:budgetservice::AccountId:budget/budgetName .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html .PARAMETER BudgetLimit + The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget. +BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions. + Type: Spend Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetlimit UpdateType: Mutable .PARAMETER TimePeriod + The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. +The start date for a budget. If you created your budget and didn't specify a start date, the start date defaults to the start of the chosen time period MONTHLY, QUARTERLY, or ANNUALLY. For example, if you create your budget on January 24, 2019, choose MONTHLY, and don't set a start date, the start date defaults to 01/01/19 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API. +You can change your start date with the UpdateBudget operation. +After the end date, AWS deletes the budget and all associated notifications and subscribers. + Type: TimePeriod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeperiod UpdateType: Mutable .PARAMETER TimeUnit + The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeunit PrimitiveType: String UpdateType: Mutable .PARAMETER PlannedBudgetLimits + + Budget: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_budget.html in the *AWS Cost Explorer Service Cost Management APIs* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-plannedbudgetlimits PrimitiveType: Json UpdateType: Immutable .PARAMETER CostFilters + The cost filters, such as service or tag, that are applied to a budget. +AWS Budgets supports the following services as a filter for RI budgets: ++ Amazon Elastic Compute Cloud - Compute ++ Amazon Redshift ++ Amazon Relational Database Service ++ Amazon ElastiCache ++ Amazon Elasticsearch Service + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costfilters PrimitiveType: Json UpdateType: Mutable .PARAMETER BudgetName + The name of a budget. The value must be unique within an account. BudgetName can't include : and characters. If you don't include value for BudgetName in the template, Billing and Cost Management assigns your budget a randomly generated name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetname PrimitiveType: String UpdateType: Immutable .PARAMETER CostTypes + The types of costs that are included in this COST budget. +USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes. + Type: CostTypes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costtypes UpdateType: Mutable .PARAMETER BudgetType + Whether this budget tracks costs, usage, RI utilization, or RI coverage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgettype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 index b2dc42d5e..b8a7ccf15 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 @@ -1,66 +1,101 @@ function Add-VSBudgetsBudgetCostTypes { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.CostTypes resource property to the template. + Adds an AWS::Budgets::Budget.CostTypes resource property to the template. The types of cost that are included in a COST budget, such as tax and subscriptions. .DESCRIPTION Adds an AWS::Budgets::Budget.CostTypes resource property to the template. +The types of cost that are included in a COST budget, such as tax and subscriptions. +USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html .PARAMETER IncludeSupport + Specifies whether a budget includes support subscription fees. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesupport PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeOtherSubscription + Specifies whether a budget includes non-RI subscription costs. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeothersubscription PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeTax + Specifies whether a budget includes taxes. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includetax PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeSubscription + Specifies whether a budget includes subscriptions. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesubscription PrimitiveType: Boolean UpdateType: Mutable .PARAMETER UseBlended + Specifies whether a budget uses a blended rate. +The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useblended PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeUpfront + Specifies whether a budget includes upfront RI costs. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeupfront PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeDiscount + Specifies whether a budget includes discounts. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includediscount PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeCredit + Specifies whether a budget includes credits. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includecredit PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeRecurring + Specifies whether a budget includes recurring fees such as monthly RI fees. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerecurring PrimitiveType: Boolean UpdateType: Mutable .PARAMETER UseAmortized + Specifies whether a budget uses the amortized rate. +The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useamortized PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeRefund + Specifies whether a budget includes refunds. +The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerefund PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 index bd9e5c162..2ae5452a9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 @@ -1,31 +1,51 @@ function Add-VSBudgetsBudgetNotification { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.Notification resource property to the template. + Adds an AWS::Budgets::Budget.Notification resource property to the template. A notification that is associated with a budget. A budget can have up to five notifications. .DESCRIPTION Adds an AWS::Budgets::Budget.Notification resource property to the template. +A notification that is associated with a budget. A budget can have up to five notifications. +Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers. + +For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters: + ++ A notificationType of ACTUAL + ++ A thresholdType of PERCENTAGE + ++ A comparisonOperator of GREATER_THAN + ++ A notification threshold of 80 .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html .PARAMETER ComparisonOperator + The comparison that is used for this notification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationType + Whether the notification is for how much you have spent ACTUAL or for how much you're forecasted to spend FORECASTED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-notificationtype PrimitiveType: String UpdateType: Mutable .PARAMETER Threshold + The threshold that is associated with a notification. Thresholds are always a percentage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-threshold PrimitiveType: Double UpdateType: Mutable .PARAMETER ThresholdType + The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-thresholdtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotificationWithSubscribers.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotificationWithSubscribers.ps1 index a588dbaf8..76175dfba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotificationWithSubscribers.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotificationWithSubscribers.ps1 @@ -1,22 +1,26 @@ function Add-VSBudgetsBudgetNotificationWithSubscribers { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.NotificationWithSubscribers resource property to the template. + Adds an AWS::Budgets::Budget.NotificationWithSubscribers resource property to the template. A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers. .DESCRIPTION Adds an AWS::Budgets::Budget.NotificationWithSubscribers resource property to the template. - +A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html .PARAMETER Subscribers + A list of subscribers who are subscribed to this notification. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-subscribers ItemType: Subscriber UpdateType: Mutable .PARAMETER Notification + The notification that is associated with a budget. + Type: Notification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-notification UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSpend.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSpend.ps1 index 3d196dcd5..a370bf10d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSpend.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSpend.ps1 @@ -1,21 +1,31 @@ function Add-VSBudgetsBudgetSpend { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.Spend resource property to the template. + Adds an AWS::Budgets::Budget.Spend resource property to the template. The amount of cost or usage that is measured for a budget. .DESCRIPTION Adds an AWS::Budgets::Budget.Spend resource property to the template. +The amount of cost or usage that is measured for a budget. +For example, a Spend for 3 GB of S3 usage would have the following parameters: + ++ An Amount of 3 + ++ A unit of GB .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html .PARAMETER Amount + The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-amount PrimitiveType: Double UpdateType: Mutable .PARAMETER Unit + The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSubscriber.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSubscriber.ps1 index d86bb5a81..eddd8dfc1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSubscriber.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetSubscriber.ps1 @@ -1,21 +1,32 @@ function Add-VSBudgetsBudgetSubscriber { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.Subscriber resource property to the template. + Adds an AWS::Budgets::Budget.Subscriber resource property to the template. The Subscriber property type specifies who to notify for a Billing and Cost Management budget notification. The subscriber consists of a subscription type, and either an Amazon SNS topic or an email address. .DESCRIPTION Adds an AWS::Budgets::Budget.Subscriber resource property to the template. +The Subscriber property type specifies who to notify for a Billing and Cost Management budget notification. The subscriber consists of a subscription type, and either an Amazon SNS topic or an email address. +For example, an email subscriber would have the following parameters: + ++ A subscriptionType of EMAIL + ++ An address of example@example.com .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html .PARAMETER SubscriptionType + The type of notification that AWS sends to a subscriber. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-subscriptiontype PrimitiveType: String UpdateType: Mutable .PARAMETER Address + The address that AWS sends budget notifications to, either an SNS topic or an email. +When you create a subscriber, the value of Address can't contain line breaks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-address PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetTimePeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetTimePeriod.ps1 index d487de809..7c2b9bfdd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetTimePeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetTimePeriod.ps1 @@ -1,21 +1,30 @@ function Add-VSBudgetsBudgetTimePeriod { <# .SYNOPSIS - Adds an AWS::Budgets::Budget.TimePeriod resource property to the template. + Adds an AWS::Budgets::Budget.TimePeriod resource property to the template. The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. .DESCRIPTION Adds an AWS::Budgets::Budget.TimePeriod resource property to the template. - +The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html .PARAMETER Start + The start date for a budget. If you created your budget and didn't specify a start date, the start date defaults to the start of the chosen time period MONTHLY, QUARTERLY, or ANNUALLY. For example, if you create your budget on January 24, 2019, choose MONTHLY, and don't set a start date, the start date defaults to 01/01/19 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API. +You can change your start date with the UpdateBudget operation. +Valid values depend on the value of BudgetType: ++ If BudgetType is COST or USAGE: Valid values are MONTHLY, QUARTERLY, and ANNUALLY. ++ If BudgetType is RI_UTILIZATION or RI_COVERAGE: Valid values are DAILY, MONTHLY, QUARTERLY, and ANNUALLY. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-start PrimitiveType: String UpdateType: Mutable .PARAMETER End + The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API. +After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-end PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCertificateManagerCertificateDomainValidationOption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCertificateManagerCertificateDomainValidationOption.ps1 index 57c95df53..11624552d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCertificateManagerCertificateDomainValidationOption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCertificateManagerCertificateDomainValidationOption.ps1 @@ -1,21 +1,30 @@ function Add-VSCertificateManagerCertificateDomainValidationOption { <# .SYNOPSIS - Adds an AWS::CertificateManager::Certificate.DomainValidationOption resource property to the template. + Adds an AWS::CertificateManager::Certificate.DomainValidationOption resource property to the template. DomainValidationOption is a property of the AWS::CertificateManager::Certificate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html resource that specifies the AWS Certificate Manager (ACM certificate domain to which ACM will send validation emails. .DESCRIPTION Adds an AWS::CertificateManager::Certificate.DomainValidationOption resource property to the template. - +DomainValidationOption is a property of the AWS::CertificateManager::Certificate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html resource that specifies the AWS Certificate Manager (ACM certificate domain to which ACM will send validation emails. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html .PARAMETER DomainName + A fully qualified domain name FQDN in the certificate request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoptions-domainname PrimitiveType: String UpdateType: Mutable .PARAMETER ValidationDomain + The domain name to which you want ACM to send validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com as this value. In that case, ACM sends domain validation emails to the following five addresses: ++ admin@example.com ++ administrator@example.com ++ hostmaster@example.com ++ postmaster@example.com ++ webmaster@example.com + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-validationdomain PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloud9EnvironmentEC2Repository.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloud9EnvironmentEC2Repository.ps1 index 29ecc9ab2..67ce2c73a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloud9EnvironmentEC2Repository.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloud9EnvironmentEC2Repository.ps1 @@ -1,21 +1,25 @@ function Add-VSCloud9EnvironmentEC2Repository { <# .SYNOPSIS - Adds an AWS::Cloud9::EnvironmentEC2.Repository resource property to the template. + Adds an AWS::Cloud9::EnvironmentEC2.Repository resource property to the template. The Repository property type specifies an AWS CodeCommit source code repository to be cloned into an AWS Cloud9 development environment. .DESCRIPTION Adds an AWS::Cloud9::EnvironmentEC2.Repository resource property to the template. - +The Repository property type specifies an AWS CodeCommit source code repository to be cloned into an AWS Cloud9 development environment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html .PARAMETER PathComponent + The path within the development environment's default file system location to clone the AWS CodeCommit repository into. For example, /REPOSITORY_NAME would clone the repository into the /home/USER_NAME/environment/REPOSITORY_NAME directory in the environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html#cfn-cloud9-environmentec2-repository-pathcomponent PrimitiveType: String UpdateType: Mutable .PARAMETER RepositoryUrl + The clone URL of the AWS CodeCommit repository to be cloned. For example, for an AWS CodeCommit repository this might be https://git-codecommit.us-east-2.amazonaws.com/v1/repos/REPOSITORY_NAME. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html#cfn-cloud9-environmentec2-repository-repositoryurl PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontCloudFrontOriginAccessIdentityCloudFrontOriginAccessIdentityConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontCloudFrontOriginAccessIdentityCloudFrontOriginAccessIdentityConfig.ps1 index c73841bc7..790b52e32 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontCloudFrontOriginAccessIdentityCloudFrontOriginAccessIdentityConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontCloudFrontOriginAccessIdentityCloudFrontOriginAccessIdentityConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSCloudFrontCloudFrontOriginAccessIdentityCloudFrontOriginAccessIdentityConfig { <# .SYNOPSIS - Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig resource property to the template. + Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig resource property to the template. Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource. .DESCRIPTION Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig resource property to the template. - +Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html .PARAMETER Comment + Any comments you want to include about the origin access identity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-comment PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 index f1959e1c9..e9d5c5391 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 @@ -1,85 +1,144 @@ function Add-VSCloudFrontDistributionCacheBehavior { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.CacheBehavior resource property to the template. + Adds an AWS::CloudFront::Distribution.CacheBehavior resource property to the template. A complex type that describes how CloudFront processes requests. .DESCRIPTION Adds an AWS::CloudFront::Distribution.CacheBehavior resource property to the template. +A complex type that describes how CloudFront processes requests. +You must create at least as many cache behaviors (including the default cache behavior as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used. + +For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront in the *AWS General Reference*. + +If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. + +To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. + +To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution. + +For more information about cache behaviors, see Cache Behaviors: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior in the *Amazon CloudFront Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html .PARAMETER Compress + Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-compress PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LambdaFunctionAssociations + A complex type that contains zero or more Lambda function associations for a cache behavior. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations ItemType: LambdaFunctionAssociation UpdateType: Mutable .PARAMETER TargetOriginId + The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-targetoriginid PrimitiveType: String UpdateType: Mutable .PARAMETER ViewerProtocolPolicy + The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options: ++ allow-all: Viewers can use HTTP or HTTPS. ++ redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 Moved Permanently to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. ++ https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 Forbidden. +For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html in the *Amazon CloudFront Developer Guide*. +The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER TrustedSigners + A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. +If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the *Amazon CloudFront Developer Guide*. +If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. +To add, change, or remove one or more trusted signers, change Enabled to true if it's currently false, change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedsigners UpdateType: Mutable .PARAMETER DefaultTTL + The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-defaultttl PrimitiveType: Double UpdateType: Mutable .PARAMETER FieldLevelEncryptionId + The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid PrimitiveType: String UpdateType: Mutable .PARAMETER AllowedMethods + A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: ++ CloudFront forwards only GET and HEAD requests. ++ CloudFront forwards only GET, HEAD, and OPTIONS requests. ++ CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. +If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-allowedmethods UpdateType: Mutable .PARAMETER PathPattern + The pattern for example, images/*.jpg that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. +You can optionally include a slash / at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /. +The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. +For more information, see Path Pattern: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern in the * Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-pathpattern PrimitiveType: String UpdateType: Mutable .PARAMETER CachedMethods + A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: ++ CloudFront caches responses to GET and HEAD requests. ++ CloudFront caches responses to GET, HEAD, and OPTIONS requests. +If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachedmethods UpdateType: Mutable .PARAMETER SmoothStreaming + Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-smoothstreaming PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ForwardedValues + A complex type that specifies how CloudFront handles query strings and cookies. + Type: ForwardedValues Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-forwardedvalues UpdateType: Mutable .PARAMETER MinTTL + The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the * Amazon CloudFront Developer Guide*. +You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin under Headers, if you specify 1 for Quantity and * for Name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-minttl PrimitiveType: Double UpdateType: Mutable .PARAMETER MaxTTL + The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-maxttl PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 index f7fe55bb3..25ca409d0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 @@ -1,22 +1,29 @@ function Add-VSCloudFrontDistributionCookies { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.Cookies resource property to the template. + Adds an AWS::CloudFront::Distribution.Cookies resource property to the template. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html in the *Amazon CloudFront Developer Guide*. .DESCRIPTION Adds an AWS::CloudFront::Distribution.Cookies resource property to the template. - +A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html in the *Amazon CloudFront Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html .PARAMETER WhitelistedNames + Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. +If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically. +For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits: https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront in the *AWS General Reference*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-whitelistednames UpdateType: Mutable .PARAMETER Forward + Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type. +Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-forward PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 index 45ee1d2d9..ae1ed59fc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 @@ -1,31 +1,55 @@ function Add-VSCloudFrontDistributionCustomErrorResponse { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.CustomErrorResponse resource property to the template. + Adds an AWS::CloudFront::Distribution.CustomErrorResponse resource property to the template. A complex type that controls: .DESCRIPTION Adds an AWS::CloudFront::Distribution.CustomErrorResponse resource property to the template. +A complex type that controls: ++ Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + ++ How long CloudFront caches HTTP status codes in the 4xx and 5xx range. + +For more information about custom error pages, see Customizing Error Responses: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html in the *Amazon CloudFront Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html .PARAMETER ResponseCode + The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: ++ Some Internet devices some firewalls and corporate proxies, for example intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted. ++ If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors. ++ You might want to return a 200 status code OK and static website so your customers don't know that your website is down. +If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, , in the XML document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsecode PrimitiveType: Integer UpdateType: Mutable .PARAMETER ErrorCachingMinTTL + The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. +If you don't want to specify a value, include an empty element, , in the XML document. +For more information, see Customizing Error Responses: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl PrimitiveType: Double UpdateType: Mutable .PARAMETER ErrorCode + The HTTP status code for which you want to specify a custom error page and/or a caching duration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcode PrimitiveType: Integer UpdateType: Mutable .PARAMETER ResponsePagePath + The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: ++ The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*. ++ The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages. +If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, , in the XML document. +We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsepagepath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomOriginConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomOriginConfig.ps1 index c27ed80cf..106108751 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomOriginConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomOriginConfig.ps1 @@ -1,42 +1,56 @@ function Add-VSCloudFrontDistributionCustomOriginConfig { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.CustomOriginConfig resource property to the template. + Adds an AWS::CloudFront::Distribution.CustomOriginConfig resource property to the template. A custom origin or an Amazon S3 bucket configured as a website endpoint. .DESCRIPTION Adds an AWS::CloudFront::Distribution.CustomOriginConfig resource property to the template. - +A custom origin or an Amazon S3 bucket configured as a website endpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html .PARAMETER OriginReadTimeout + You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds. +If you need to increase the maximum time limit, contact the AWS Support Center: https://console.aws.amazon.com/support/home#/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER HTTPSPort + The HTTPS port the custom origin listens on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpsport PrimitiveType: Integer UpdateType: Mutable .PARAMETER OriginKeepaliveTimeout + You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds. +If you need to increase the maximum time limit, contact the AWS Support Center: https://console.aws.amazon.com/support/home#/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER OriginSSLProtocols + The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols UpdateType: Mutable .PARAMETER HTTPPort + The HTTP port the custom origin listens on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpport PrimitiveType: Integer UpdateType: Mutable .PARAMETER OriginProtocolPolicy + The origin protocol policy to apply to your origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 index 37ea26ce5..757ee0756 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 @@ -1,80 +1,122 @@ function Add-VSCloudFrontDistributionDefaultCacheBehavior { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.DefaultCacheBehavior resource property to the template. + Adds an AWS::CloudFront::Distribution.DefaultCacheBehavior resource property to the template. A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior. .DESCRIPTION Adds an AWS::CloudFront::Distribution.DefaultCacheBehavior resource property to the template. - +A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html .PARAMETER Compress + Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-compress PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LambdaFunctionAssociations + A complex type that contains zero or more Lambda function associations for a cache behavior. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations ItemType: LambdaFunctionAssociation UpdateType: Mutable .PARAMETER TargetOriginId + The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid PrimitiveType: String UpdateType: Mutable .PARAMETER ViewerProtocolPolicy + The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options: ++ allow-all: Viewers can use HTTP or HTTPS. ++ redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 Moved Permanently to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. ++ https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 Forbidden. +For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html in the *Amazon CloudFront Developer Guide*. +The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER TrustedSigners + A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. +If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the * Amazon CloudFront Developer Guide*. +If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. +To add, change, or remove one or more trusted signers, change Enabled to true if it's currently false, change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners UpdateType: Mutable .PARAMETER DefaultTTL + The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl PrimitiveType: Double UpdateType: Mutable .PARAMETER FieldLevelEncryptionId + The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid PrimitiveType: String UpdateType: Mutable .PARAMETER AllowedMethods + A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: ++ CloudFront forwards only GET and HEAD requests. ++ CloudFront forwards only GET, HEAD, and OPTIONS requests. ++ CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. +If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods UpdateType: Mutable .PARAMETER CachedMethods + A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: ++ CloudFront caches responses to GET and HEAD requests. ++ CloudFront caches responses to GET, HEAD, and OPTIONS requests. +If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods UpdateType: Mutable .PARAMETER SmoothStreaming + Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ForwardedValues + A complex type that specifies how CloudFront handles query strings and cookies. + Type: ForwardedValues Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues UpdateType: Mutable .PARAMETER MinTTL + The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. +You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin under Headers, if you specify 1 for Quantity and * for Name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-minttl PrimitiveType: Double UpdateType: Mutable .PARAMETER MaxTTL + The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache Expiration: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-maxttl PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 index f267cea07..5adfd56f3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 @@ -1,89 +1,142 @@ function Add-VSCloudFrontDistributionDistributionConfig { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.DistributionConfig resource property to the template. + Adds an AWS::CloudFront::Distribution.DistributionConfig resource property to the template. A distribution configuration. .DESCRIPTION Adds an AWS::CloudFront::Distribution.DistributionConfig resource property to the template. - +A distribution configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html .PARAMETER Logging + A complex type that controls whether access logs are written for the distribution. +For more information about logging, see Access Logs: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html in the *Amazon CloudFront Developer Guide*. + Type: Logging Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-logging UpdateType: Mutable .PARAMETER Comment + Any comments you want to include about the distribution. +If you don't want to specify a comment, include an empty Comment element. +To delete an existing comment, update the distribution configuration and include an empty Comment element. +To add or change a comment, update the distribution configuration and specify the new comment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-comment PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultRootObject + The object that you want CloudFront to request from your origin for example, index.html when a viewer requests the root URL for your distribution http://www.example.com instead of an object in your distribution http://www.example.com/product-description.html. Specifying a default root object avoids exposing the contents of your distribution. +Specify only the object name, for example, index.html. Don't add a / before the object name. +If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. +To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. +To replace the default root object, update the distribution configuration and specify the new object. +For more information about the default root object, see Creating a Default Root Object: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultrootobject PrimitiveType: String UpdateType: Mutable .PARAMETER Origins + A complex type that contains information about origins for this distribution. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-origins ItemType: Origin UpdateType: Mutable .PARAMETER ViewerCertificate + A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager ACM or a third-party certificate authority. + Type: ViewerCertificate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-viewercertificate UpdateType: Mutable .PARAMETER PriceClass + The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations. +If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. +For more information about price classes, see Choosing the Price Class for a CloudFront Distribution: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes such as Price Class 100 map to CloudFront regions, see Amazon CloudFront Pricing: http://aws.amazon.com/cloudfront/pricing/. For price class information, scroll down to see the table at the bottom of the page. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-priceclass PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultCacheBehavior + A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior. + Type: DefaultCacheBehavior Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior UpdateType: Mutable .PARAMETER CustomErrorResponses + A complex type that controls the following: ++ Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. ++ How long CloudFront caches HTTP status codes in the 4xx and 5xx range. +For more information about custom error pages, see Customizing Error Responses: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html in the *Amazon CloudFront Developer Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-customerrorresponses ItemType: CustomErrorResponse UpdateType: Mutable .PARAMETER Enabled + From this field, you can enable or disable the selected distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Aliases + A complex type that contains information about CNAMEs alternate domain names, if any, for this distribution. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases UpdateType: Mutable .PARAMETER IPV6Enabled + If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. +In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content or restrict access but not by IP address, you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html in the *Amazon CloudFront Developer Guide*. +If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: ++ You enable IPv6 for the distribution ++ You're using alternate domain names in the URLs for your objects +For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html in the *Amazon Route 53 Developer Guide*. +If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-ipv6enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER WebACLId + A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. +AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code Forbidden. You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide: http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-webaclid PrimitiveType: String UpdateType: Mutable .PARAMETER HttpVersion + Optional Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version. +For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification SNI. +In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization." + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-httpversion PrimitiveType: String UpdateType: Mutable .PARAMETER Restrictions + A complex type that identifies ways in which you want to restrict distribution of your content. + Type: Restrictions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions UpdateType: Mutable .PARAMETER CacheBehaviors + A complex type that contains zero or more CacheBehavior elements. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-cachebehaviors ItemType: CacheBehavior diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 index ef05dd3ed..bbdaf2bb5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 @@ -1,32 +1,45 @@ function Add-VSCloudFrontDistributionForwardedValues { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.ForwardedValues resource property to the template. + Adds an AWS::CloudFront::Distribution.ForwardedValues resource property to the template. A complex type that specifies how CloudFront handles query strings and cookies. .DESCRIPTION Adds an AWS::CloudFront::Distribution.ForwardedValues resource property to the template. - +A complex type that specifies how CloudFront handles query strings and cookies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html .PARAMETER Cookies + A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html in the *Amazon CloudFront Developer Guide*. + Type: Cookies Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-cookies UpdateType: Mutable .PARAMETER Headers + A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior whitelisted headers. For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. +For more information, see Caching Content Based on Request Headers: https://docs.aws.amazon.com/Cookies.html in the *Amazon CloudFront Developer Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-headers UpdateType: Mutable .PARAMETER QueryString + Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any: +If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. +If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. +If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. +For more information, see Configuring CloudFront to Cache Based on Query String Parameters: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystring PrimitiveType: Boolean UpdateType: Mutable .PARAMETER QueryStringCacheKeys + A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionGeoRestriction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionGeoRestriction.ps1 index d906e27a7..e489d2f30 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionGeoRestriction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionGeoRestriction.ps1 @@ -1,22 +1,31 @@ function Add-VSCloudFrontDistributionGeoRestriction { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.GeoRestriction resource property to the template. + Adds an AWS::CloudFront::Distribution.GeoRestriction resource property to the template. A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases. .DESCRIPTION Adds an AWS::CloudFront::Distribution.GeoRestriction resource property to the template. - +A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html .PARAMETER Locations + A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content whitelist or not distribute your content blacklist. +The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. +CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-locations UpdateType: Mutable .PARAMETER RestrictionType + The method that you want to use to restrict distribution of your content by country: ++ none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. ++ blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content. ++ whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-restrictiontype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLambdaFunctionAssociation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLambdaFunctionAssociation.ps1 index 133867349..06c6f000b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLambdaFunctionAssociation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLambdaFunctionAssociation.ps1 @@ -1,21 +1,30 @@ function Add-VSCloudFrontDistributionLambdaFunctionAssociation { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.LambdaFunctionAssociation resource property to the template. + Adds an AWS::CloudFront::Distribution.LambdaFunctionAssociation resource property to the template. A complex type that contains a Lambda function association. .DESCRIPTION Adds an AWS::CloudFront::Distribution.LambdaFunctionAssociation resource property to the template. - +A complex type that contains a Lambda function association. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html .PARAMETER EventType + Specifies the event type that triggers a Lambda function invocation. You can specify the following values: ++ viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. ++ origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute. ++ origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. ++ viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. +If the origin returns an HTTP status code other than HTTP 200 OK, the function doesn't execute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaFunctionARN + The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLogging.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLogging.ps1 index 9bb32721b..5dcd1e37d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLogging.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionLogging.ps1 @@ -1,26 +1,32 @@ function Add-VSCloudFrontDistributionLogging { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.Logging resource property to the template. + Adds an AWS::CloudFront::Distribution.Logging resource property to the template. A complex type that controls whether access logs are written for the distribution. .DESCRIPTION Adds an AWS::CloudFront::Distribution.Logging resource property to the template. - +A complex type that controls whether access logs are written for the distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html .PARAMETER IncludeCookies + Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-includecookies PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Bucket + The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-prefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 index 8a3f01895..8116159f7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 @@ -1,42 +1,73 @@ function Add-VSCloudFrontDistributionOrigin { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.Origin resource property to the template. + Adds an AWS::CloudFront::Distribution.Origin resource property to the template. A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server, Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group. .DESCRIPTION Adds an AWS::CloudFront::Distribution.Origin resource property to the template. +A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server, Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group. +For the current limit on the number of origins or origin groups that you can specify for a distribution, see Amazon CloudFront Limits: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront in the *AWS General Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html .PARAMETER OriginCustomHeaders + A complex type that contains names and values for the custom headers that you want. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-origincustomheaders ItemType: OriginCustomHeader UpdateType: Mutable .PARAMETER DomainName + **Amazon S3 origins**: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket. +For more information about specifying this value for different types of origins, see Origin Domain Name: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName in the *Amazon CloudFront Developer Guide*. +Constraints for Amazon S3 origins: ++ If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName. ++ The bucket name must be between 3 and 63 characters long inclusive. ++ The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes. ++ The bucket name must not contain adjacent periods. +**Custom Origins**: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com. +Constraints for custom origins: ++ DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot ., hyphen -, or underscore _ characters. ++ The name cannot exceed 128 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-domainname PrimitiveType: String UpdateType: Mutable .PARAMETER S3OriginConfig + A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead. + Type: S3OriginConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-s3originconfig UpdateType: Mutable .PARAMETER OriginPath + An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name. +For example, suppose you've specified the following values for your distribution: ++ DomainName: An Amazon S3 bucket named myawsbucket. ++ OriginPath: /production ++ CNAME: example.com +When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html. +When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-originpath PrimitiveType: String UpdateType: Mutable .PARAMETER Id + A unique identifier for the origin or origin group. The value of Id must be unique within the distribution. +When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-id PrimitiveType: String UpdateType: Mutable .PARAMETER CustomOriginConfig + A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead. + Type: CustomOriginConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-customoriginconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOriginCustomHeader.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOriginCustomHeader.ps1 index bda959631..2613633f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOriginCustomHeader.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOriginCustomHeader.ps1 @@ -1,21 +1,25 @@ function Add-VSCloudFrontDistributionOriginCustomHeader { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.OriginCustomHeader resource property to the template. + Adds an AWS::CloudFront::Distribution.OriginCustomHeader resource property to the template. A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution. .DESCRIPTION Adds an AWS::CloudFront::Distribution.OriginCustomHeader resource property to the template. - +A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html .PARAMETER HeaderValue + The value for the header that you specified in the HeaderName field. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headervalue PrimitiveType: String UpdateType: Mutable .PARAMETER HeaderName + The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin Web Distributions Only: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html in the * Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionRestrictions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionRestrictions.ps1 index f841a4bbd..f35744d34 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionRestrictions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionRestrictions.ps1 @@ -1,16 +1,18 @@ function Add-VSCloudFrontDistributionRestrictions { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.Restrictions resource property to the template. + Adds an AWS::CloudFront::Distribution.Restrictions resource property to the template. A complex type that identifies ways in which you want to restrict distribution of your content. .DESCRIPTION Adds an AWS::CloudFront::Distribution.Restrictions resource property to the template. - +A complex type that identifies ways in which you want to restrict distribution of your content. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html .PARAMETER GeoRestriction + A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases. + Type: GeoRestriction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html#cfn-cloudfront-distribution-restrictions-georestriction UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionS3OriginConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionS3OriginConfig.ps1 index dae506262..448c53edb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionS3OriginConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionS3OriginConfig.ps1 @@ -1,16 +1,24 @@ function Add-VSCloudFrontDistributionS3OriginConfig { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.S3OriginConfig resource property to the template. + Adds an AWS::CloudFront::Distribution.S3OriginConfig resource property to the template. A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead. .DESCRIPTION Adds an AWS::CloudFront::Distribution.S3OriginConfig resource property to the template. - +A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html .PARAMETER OriginAccessIdentity + The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: +origin-access-identity/cloudfront/*ID-of-origin-access-identity* +where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity. +If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. +To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. +To replace the origin access identity, update the distribution configuration and specify the new origin access identity. +For more information about the origin access identity, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html#cfn-cloudfront-distribution-s3originconfig-originaccessidentity PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 index ea983b3a1..06ab0462f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 @@ -1,36 +1,80 @@ function Add-VSCloudFrontDistributionViewerCertificate { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.ViewerCertificate resource property to the template. + Adds an AWS::CloudFront::Distribution.ViewerCertificate resource property to the template. A complex type that specifies the following: .DESCRIPTION Adds an AWS::CloudFront::Distribution.ViewerCertificate resource property to the template. +A complex type that specifies the following: ++ Whether you want viewers to use HTTP or HTTPS to request your objects. + ++ If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net. + ++ If you're using an alternate domain name, whether AWS Certificate Manager (ACM provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store. + +Specify only one of the following values: + ++ ACMCertificateArn: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn + ++ IAMCertificateId: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId + ++ CloudFrontDefaultCertificate: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-CloudFrontDefaultCertificate + +For more information, see Using Alternate Domain Names and HTTPS: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS in the *Amazon CloudFront Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html .PARAMETER IamCertificateId + If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority: ++ IAM certificate ID where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store. +If you specify IAMCertificateId, you must also specify a value for SSLSupportMethod. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-iamcertificateid PrimitiveType: String UpdateType: Mutable .PARAMETER SslSupportMethod + If you specify a value for ACMCertificateArn: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn or for IAMCertificateId: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients. ++ sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication SNI. All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication: http://en.wikipedia.org/wiki/Server_Name_Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-https-dedicated-ip-or-sni.html in the *Amazon CloudFront Developer Guide*. ++ vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront: http://aws.amazon.com/cloudfront/custom-ssl-domains/ on the AWS marketing site. +Don't specify a value for SSLSupportMethod if you specified true. +For more information, see Choosing How CloudFront Serves HTTPS Requests: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-https-dedicated-ip-or-sni.html in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod PrimitiveType: String UpdateType: Mutable .PARAMETER MinimumProtocolVersion + Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings: ++ The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers ++ The cipher that CloudFront uses to encrypt the content that it returns to viewers +On the CloudFront console, this setting is called **Security policy**. +We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later. +When both of the following are true, you must specify TLSv1 or later for the security policy: ++ You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId ++ You're using SNI: you specified sni-only for SSLSupportMethod +If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion. +For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers in the *Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion PrimitiveType: String UpdateType: Mutable .PARAMETER CloudFrontDefaultCertificate + If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value: ++ true + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AcmCertificateArn + If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate: ++ ARN for ACM SSL/TLS certificate where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution. +If you specify ACMCertificateArn, you must also specify a value for SSLSupportMethod. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionLogging.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionLogging.ps1 index 05415e7bc..bdab77958 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionLogging.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionLogging.ps1 @@ -1,26 +1,32 @@ function Add-VSCloudFrontStreamingDistributionLogging { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution.Logging resource property to the template. + Adds an AWS::CloudFront::StreamingDistribution.Logging resource property to the template. A complex type that controls whether access logs are written for the streaming distribution. .DESCRIPTION Adds an AWS::CloudFront::StreamingDistribution.Logging resource property to the template. - +A complex type that controls whether access logs are written for the streaming distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html .PARAMETER Bucket + The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Prefix + An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-prefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionS3Origin.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionS3Origin.ps1 index 6748be370..ed44392c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionS3Origin.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionS3Origin.ps1 @@ -1,21 +1,29 @@ function Add-VSCloudFrontStreamingDistributionS3Origin { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution.S3Origin resource property to the template. + Adds an AWS::CloudFront::StreamingDistribution.S3Origin resource property to the template. A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. .DESCRIPTION Adds an AWS::CloudFront::StreamingDistribution.S3Origin resource property to the template. - +A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html .PARAMETER DomainName + The DNS name of the Amazon S3 origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-domainname PrimitiveType: String UpdateType: Mutable .PARAMETER OriginAccessIdentity + The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront. +If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. +To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. +To replace the origin access identity, update the distribution configuration and specify the new origin access identity. +For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html in the * Amazon CloudFront Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionStreamingDistributionConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionStreamingDistributionConfig.ps1 index 8940f4e8c..cadc8e1de 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionStreamingDistributionConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionStreamingDistributionConfig.ps1 @@ -1,47 +1,61 @@ function Add-VSCloudFrontStreamingDistributionStreamingDistributionConfig { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig resource property to the template. + Adds an AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig resource property to the template. The RTMP distribution's configuration information. .DESCRIPTION Adds an AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig resource property to the template. - +The RTMP distribution's configuration information. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html .PARAMETER Logging + A complex type that controls whether access logs are written for the streaming distribution. + Type: Logging Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging UpdateType: Mutable .PARAMETER Comment + Any comments you want to include about the streaming distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment PrimitiveType: String UpdateType: Mutable .PARAMETER PriceClass + A complex type that contains information about price class for this streaming distribution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass PrimitiveType: String UpdateType: Mutable .PARAMETER S3Origin + A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. + Type: S3Origin Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin UpdateType: Mutable .PARAMETER Enabled + Whether the streaming distribution is enabled to accept user requests for content. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Aliases + A complex type that contains information about CNAMEs alternate domain names, if any, for this streaming distribution. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases UpdateType: Mutable .PARAMETER TrustedSigners + A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the *Amazon CloudFront Developer Guide*. + Type: TrustedSigners Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 index 17acb8460..8770164f9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 @@ -1,21 +1,35 @@ function Add-VSCloudFrontStreamingDistributionTrustedSigners { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution.TrustedSigners resource property to the template. + Adds an AWS::CloudFront::StreamingDistribution.TrustedSigners resource property to the template. A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. .DESCRIPTION Adds an AWS::CloudFront::StreamingDistribution.TrustedSigners resource property to the template. +A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. +If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the * Amazon CloudFront Developer Guide*. + +If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. + +To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false, change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + +For more information about updating the distribution configuration, see DistributionConfig: https://docs.aws.amazon.com/cloudfront/latest/APIReference/DistributionConfig.html in the *Amazon CloudFront API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html .PARAMETER Enabled + Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AwsAccountNumbers + An AWS account that is included in the TrustedSigners complex type for this distribution. Valid values include: ++ self, which is the AWS account used to create the distribution. ++ An AWS account number. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 index 91608e14e..8464ce469 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 @@ -1,21 +1,58 @@ function Add-VSCloudTrailTrailDataResource { <# .SYNOPSIS - Adds an AWS::CloudTrail::Trail.DataResource resource property to the template. + Adds an AWS::CloudTrail::Trail.DataResource resource property to the template. The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. .DESCRIPTION Adds an AWS::CloudTrail::Trail.DataResource resource property to the template. +The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. +**Note** + +The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors. + +The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events. + +1. A user uploads an image file to bucket-1. + +1. The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event. + +1. A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2. + +1. The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event. + +The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named *MyLambdaFunction*, but not for all AWS Lambda functions. + +1. A user runs a script that includes a call to the *MyLambdaFunction* function and the *MyOtherLambdaFunction* function. + +1. The Invoke API operation on *MyLambdaFunction* is an AWS Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for *MyLambdaFunction*, any invocations of that function are logged. The trail processes and logs the event. + +1. The Invoke API operation on *MyOtherLambdaFunction* is an AWS Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for *MyOtherLambdaFunction* does not match the function specified for the trail. The trail doesn’t log the event. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html .PARAMETER Type + The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-type PrimitiveType: String UpdateType: Mutable .PARAMETER Values + An array of Amazon Resource Name ARN strings or partial ARN strings for the specified objects. ++ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as arn:aws:s3:::. +**Note** +This will also enable logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account. ++ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket. ++ To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix. ++ To log data events for all functions in your AWS account, specify the prefix as arn:aws:lambda. +**Note** +This will also enable logging of Invoke activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account. ++ To log data events for a specific Lambda function, specify the function ARN. +**Note** +Lambda function ARNs are exact. For example, if you specify a function ARN *arn:aws:lambda:us-west-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us-west-2:111111111111:function:helloworld*. They will not be logged for *arn:aws:lambda:us-west-2:111111111111:function:helloworld2*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailEventSelector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailEventSelector.ps1 index ec0713484..2042957c8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailEventSelector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailEventSelector.ps1 @@ -1,16 +1,21 @@ function Add-VSCloudTrailTrailEventSelector { <# .SYNOPSIS - Adds an AWS::CloudTrail::Trail.EventSelector resource property to the template. + Adds an AWS::CloudTrail::Trail.EventSelector resource property to the template. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. .DESCRIPTION Adds an AWS::CloudTrail::Trail.EventSelector resource property to the template. +Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. +You can configure up to five event selectors for a trail. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html .PARAMETER DataResources + CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. +For more information, see Data Events: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events and Limits in AWS CloudTrail: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html in the *AWS CloudTrail User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-dataresources DuplicatesAllowed: False ItemType: DataResource @@ -18,11 +23,18 @@ function Add-VSCloudTrailTrailEventSelector { UpdateType: Mutable .PARAMETER IncludeManagementEvents + Specify if you want your event selector to include management events for your trail. +For more information, see Management Events: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events in the *AWS CloudTrail User Guide*. +By default, the value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-includemanagementevents PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ReadWriteType + Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. +By default, the value is All. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-readwritetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmDimension.ps1 index 3af84735f..227447056 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSCloudWatchAlarmDimension { <# .SYNOPSIS - Adds an AWS::CloudWatch::Alarm.Dimension resource property to the template. + Adds an AWS::CloudWatch::Alarm.Dimension resource property to the template. Dimension is an embedded property of the AWS::CloudWatch::Alarm type. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. You can specify a maximum of 10 dimensions for a given metric. .DESCRIPTION Adds an AWS::CloudWatch::Alarm.Dimension resource property to the template. - +Dimension is an embedded property of the AWS::CloudWatch::Alarm type. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. You can specify a maximum of 10 dimensions for a given metric. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html .PARAMETER Name + The name of the dimension, from 1–255 characters in length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value for the dimension, from 1–255 characters in length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetric.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetric.ps1 index 79eb34c78..29d871a8f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetric.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetric.ps1 @@ -1,16 +1,18 @@ function Add-VSCloudWatchAlarmMetric { <# .SYNOPSIS - Adds an AWS::CloudWatch::Alarm.Metric resource property to the template. + Adds an AWS::CloudWatch::Alarm.Metric resource property to the template. The Metric property type represents a specific metric. Metric is a property of the MetricStat: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html property type. .DESCRIPTION Adds an AWS::CloudWatch::Alarm.Metric resource property to the template. - +The Metric property type represents a specific metric. Metric is a property of the MetricStat: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html .PARAMETER Dimensions + The dimensions for the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-dimensions DuplicatesAllowed: True ItemType: Dimension @@ -18,11 +20,15 @@ function Add-VSCloudWatchAlarmMetric { UpdateType: Mutable .PARAMETER MetricName + The name of the metric. This is a required field. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace of the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-namespace PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricDataQuery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricDataQuery.ps1 index 2ea7f5ec2..c2682c66e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricDataQuery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricDataQuery.ps1 @@ -1,36 +1,50 @@ function Add-VSCloudWatchAlarmMetricDataQuery { <# .SYNOPSIS - Adds an AWS::CloudWatch::Alarm.MetricDataQuery resource property to the template. + Adds an AWS::CloudWatch::Alarm.MetricDataQuery resource property to the template. The MetricDataQuery property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. .DESCRIPTION Adds an AWS::CloudWatch::Alarm.MetricDataQuery resource property to the template. +The MetricDataQuery property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. +Any expression used must return a single time series. For more information, see Metric Math Syntax and Functions: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax in the *Amazon CloudWatch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html .PARAMETER Expression + The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax in the *Amazon CloudWatch User Guide*. +Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-expression PrimitiveType: String UpdateType: Mutable .PARAMETER Id + A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-id PrimitiveType: String UpdateType: Mutable .PARAMETER Label + A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-label PrimitiveType: String UpdateType: Mutable .PARAMETER MetricStat + The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. +Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-metricstat Type: MetricStat UpdateType: Mutable .PARAMETER ReturnData + This option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-returndata PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 index 4a2e8f1d4..4fb23b406 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 @@ -1,31 +1,42 @@ function Add-VSCloudWatchAlarmMetricStat { <# .SYNOPSIS - Adds an AWS::CloudWatch::Alarm.MetricStat resource property to the template. + Adds an AWS::CloudWatch::Alarm.MetricStat resource property to the template. This structure defines the metric to be returned, along with the statistics, period, and units. .DESCRIPTION Adds an AWS::CloudWatch::Alarm.MetricStat resource property to the template. +This structure defines the metric to be returned, along with the statistics, period, and units. +MetricStat is a property of the MetricDataQuery: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html .PARAMETER Metric + The metric to return, including the metric name, namespace, and dimensions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-metric Type: Metric UpdateType: Mutable .PARAMETER Period + The period, in seconds, to use when retrieving the metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-period PrimitiveType: Integer UpdateType: Mutable .PARAMETER Stat + The statistic to return. It can include any CloudWatch statistic or extended statistic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-stat PrimitiveType: String UpdateType: Mutable .PARAMETER Unit + The unit to use for the returned data points. +Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorConfiguration.ps1 index a59c277a1..e4f9c71f5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorConfiguration.ps1 @@ -1,21 +1,26 @@ function Add-VSCloudWatchAnomalyDetectorConfiguration { <# .SYNOPSIS - Adds an AWS::CloudWatch::AnomalyDetector.Configuration resource property to the template. + Adds an AWS::CloudWatch::AnomalyDetector.Configuration resource property to the template. Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric. .DESCRIPTION Adds an AWS::CloudWatch::AnomalyDetector.Configuration resource property to the template. - +Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html .PARAMETER MetricTimeZone + The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes. +To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database: https://en.wikipedia.org/wiki/Tz_database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-metrictimezone PrimitiveType: String UpdateType: Mutable .PARAMETER ExcludedTimeRanges + Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates or updates the model. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-excludedtimeranges ItemType: Range diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorDimension.ps1 index 1ebd77b6a..23e8b9068 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSCloudWatchAnomalyDetectorDimension { <# .SYNOPSIS - Adds an AWS::CloudWatch::AnomalyDetector.Dimension resource property to the template. + Adds an AWS::CloudWatch::AnomalyDetector.Dimension resource property to the template. Expands the identity of a metric. .DESCRIPTION Adds an AWS::CloudWatch::AnomalyDetector.Dimension resource property to the template. - +Expands the identity of a metric. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html .PARAMETER Value + The value representing the dimension measurement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-value PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorRange.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorRange.ps1 index 9db83018f..11581fe46 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorRange.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAnomalyDetectorRange.ps1 @@ -1,21 +1,25 @@ function Add-VSCloudWatchAnomalyDetectorRange { <# .SYNOPSIS - Adds an AWS::CloudWatch::AnomalyDetector.Range resource property to the template. + Adds an AWS::CloudWatch::AnomalyDetector.Range resource property to the template. Each Range specifies one range of days or times to exclude from use for training or updating an anomaly detection model. .DESCRIPTION Adds an AWS::CloudWatch::AnomalyDetector.Range resource property to the template. - +Each Range specifies one range of days or times to exclude from use for training or updating an anomaly detection model. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html .PARAMETER EndTime + The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-endtime PrimitiveType: String UpdateType: Mutable .PARAMETER StartTime + The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-starttime PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 index 68a302d92..d47b2420e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 @@ -1,56 +1,104 @@ function Add-VSCodeBuildProjectArtifacts { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.Artifacts resource property to the template. + Adds an AWS::CodeBuild::Project.Artifacts resource property to the template. Artifacts is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies output settings for artifacts generated by an AWS CodeBuild build. .DESCRIPTION Adds an AWS::CodeBuild::Project.Artifacts resource property to the template. - +Artifacts is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies output settings for artifacts generated by an AWS CodeBuild build. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html .PARAMETER Path + Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact: ++ If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. ++ If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. ++ If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used. +For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-path PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of build output artifact. Valid values include: ++ CODEPIPELINE: The build project has build output generated through AWS CodePipeline. ++ NO_ARTIFACTS: The build project does not produce any build output. ++ S3: The build project stores build output in Amazon Simple Storage Service Amazon S3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-type PrimitiveType: String UpdateType: Mutable .PARAMETER ArtifactIdentifier + An identifier for this artifact definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-artifactidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER OverrideArtifactName + If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-overrideartifactname PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Packaging + The type of build output artifact to create: ++ If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. ++ If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. ++ If type is set to S3, valid values include: ++ NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified. ++ ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-packaging PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionDisabled + Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-encryptiondisabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Location + Information about the build output artifact location: ++ If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. ++ If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. ++ If type is set to S3, this is the name of the output bucket. +If you specify CODEPIPELINE or NO_ARTIFACTS for the Type property, don't specify this property. For all of the other types, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-location PrimitiveType: String UpdateType: Mutable .PARAMETER Name + Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact: ++ If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. ++ If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. ++ If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash "/", the artifact is stored in the root of the output bucket. +For example: ++ If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip. ++ If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket. ++ If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/build-ID . +If you specify CODEPIPELINE or NO_ARTIFACTS for the Type property, don't specify this property. For all of the other types, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-name PrimitiveType: String UpdateType: Mutable .PARAMETER NamespaceType + Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: ++ If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. ++ If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. ++ If type is set to S3, valid values include: ++ BUILD_ID: Include the build ID in the location of the build output artifact. ++ NONE: Do not include the build ID. This is the default if namespaceType is not specified. +For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-namespacetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectCloudWatchLogsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectCloudWatchLogsConfig.ps1 index 33d34d03d..793d17cbe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectCloudWatchLogsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectCloudWatchLogsConfig.ps1 @@ -1,26 +1,34 @@ function Add-VSCodeBuildProjectCloudWatchLogsConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.CloudWatchLogsConfig resource property to the template. + Adds an AWS::CodeBuild::Project.CloudWatchLogsConfig resource property to the template. CloudWatchLogs is a property of the AWS CodeBuild Project LogsConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build. .DESCRIPTION Adds an AWS::CodeBuild::Project.CloudWatchLogsConfig resource property to the template. - +CloudWatchLogs is a property of the AWS CodeBuild Project LogsConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html .PARAMETER Status + The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: ++ ENABLED: Amazon CloudWatch Logs are enabled for this build project. ++ DISABLED: Amazon CloudWatch Logs are not enabled for this build project. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-status PrimitiveType: String UpdateType: Mutable .PARAMETER GroupName + The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-groupname PrimitiveType: String UpdateType: Mutable .PARAMETER StreamName + The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-streamname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 index b97d4478c..2bd711238 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 @@ -1,52 +1,86 @@ function Add-VSCodeBuildProjectEnvironment { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.Environment resource property to the template. + Adds an AWS::CodeBuild::Project.Environment resource property to the template. Environment is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies the environment for an AWS CodeBuild project. .DESCRIPTION Adds an AWS::CodeBuild::Project.Environment resource property to the template. - +Environment is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies the environment for an AWS CodeBuild project. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html .PARAMETER Type + The type of build environment to use for related builds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type PrimitiveType: String UpdateType: Mutable .PARAMETER EnvironmentVariables + A set of environment variables to make available to builds for this build project. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-environmentvariables ItemType: EnvironmentVariable UpdateType: Mutable .PARAMETER PrivilegedMode + Indicates how the project builds Docker images. Specify true to enable running the Docker daemon inside a Docker container. +This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. For more information, see the privilegedMode : https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-cli field in the *AWS CodeBuild User Guide*. +You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support. +If the operating system's base image is Ubuntu Linux: +- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& +- timeout 15 sh -c "until docker info; do echo .; sleep 1; done" +If the operating system's base image is Alpine Linux, add the -t argument to timeout: +- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& +- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-privilegedmode PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ImagePullCredentialsType + The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: ++ CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. ++ SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role. +When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype PrimitiveType: String UpdateType: Mutable .PARAMETER Image + The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats: ++ For an image tag: registry/repository:tag. For example, to specify an image with the tag "latest," use registry/repository:latest. ++ For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-image PrimitiveType: String UpdateType: Mutable .PARAMETER RegistryCredential + RegistryCredential is a property of the AWS::CodeBuild::Project Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment property that specifies information about credentials that provide access to a private Docker registry. When this is set: ++ imagePullCredentialsType must be set to SERVICE_ROLE. ++ images cannot be curated or an Amazon ECR image. + Type: RegistryCredential Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-registrycredential UpdateType: Mutable .PARAMETER ComputeType + The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include: ++ BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. ++ BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. ++ BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate + The certificate to use with this build project. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-certificate PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 index 67d7db80d..a5546b837 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 @@ -1,26 +1,35 @@ function Add-VSCodeBuildProjectEnvironmentVariable { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.EnvironmentVariable resource property to the template. + Adds an AWS::CodeBuild::Project.EnvironmentVariable resource property to the template. EnvironmentVariable is a property of the AWS CodeBuild Project Environment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. EnvironmentVariable contains a list of EnvironmentVariable property types. .DESCRIPTION Adds an AWS::CodeBuild::Project.EnvironmentVariable resource property to the template. - +EnvironmentVariable is a property of the AWS CodeBuild Project Environment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. EnvironmentVariable contains a list of EnvironmentVariable property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html .PARAMETER Type + The type of environment variable. Valid values include: ++ PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. ++ PLAINTEXT: An environment variable in plaintext format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of the environment variable. +We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface AWS CLI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name or key of the environment variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 index 65a2db470..9c119b27a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 @@ -1,11 +1,17 @@ function Add-VSCodeBuildProjectFilterGroup { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.FilterGroup resource property to the template. + Adds an AWS::CodeBuild::Project.FilterGroup resource property to the template. A list of WebhookFilter objects used to determine which webhook events are triggered. At least one WebhookFilter in the list must specify EVENT as its type. The FilterGroups property of the AWS CodeBuild Project ProjectTriggers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html property type is a list of FilterGroup objects. .DESCRIPTION Adds an AWS::CodeBuild::Project.FilterGroup resource property to the template. +A list of WebhookFilter objects used to determine which webhook events are triggered. At least one WebhookFilter in the list must specify EVENT as its type. The FilterGroups property of the AWS CodeBuild Project ProjectTriggers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html property type is a list of FilterGroup objects. +*Required:* No + +*Type:* A list of of WebhookFilter: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html objects + +*Update requires:* No interruption .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-filtergroup.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectGitSubmodulesConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectGitSubmodulesConfig.ps1 index 1df3555ea..25f06fccf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectGitSubmodulesConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectGitSubmodulesConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSCodeBuildProjectGitSubmodulesConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.GitSubmodulesConfig resource property to the template. + Adds an AWS::CodeBuild::Project.GitSubmodulesConfig resource property to the template. GitSubmodulesConfig is a property of the AWS CodeBuild Project Source: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html property type that specifies information about the Git submodules configuration for the build project. .DESCRIPTION Adds an AWS::CodeBuild::Project.GitSubmodulesConfig resource property to the template. - +GitSubmodulesConfig is a property of the AWS CodeBuild Project Source: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html property type that specifies information about the Git submodules configuration for the build project. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html .PARAMETER FetchSubmodules + Set to true to fetch Git submodules for your AWS CodeBuild build project. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html#cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 index 469f40a39..a407a0a5a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSCodeBuildProjectLogsConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.LogsConfig resource property to the template. + Adds an AWS::CodeBuild::Project.LogsConfig resource property to the template. LogsConfig is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/aws-properties-codebuild-project-source.html resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. .DESCRIPTION Adds an AWS::CodeBuild::Project.LogsConfig resource property to the template. - +LogsConfig is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/aws-properties-codebuild-project-source.html resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html .PARAMETER CloudWatchLogs + Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default. + Type: CloudWatchLogsConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-cloudwatchlogs UpdateType: Mutable .PARAMETER S3Logs + Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. + Type: S3LogsConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-s3logs UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 index ea644e5d1..9d9e1c50b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 @@ -1,27 +1,48 @@ function Add-VSCodeBuildProjectProjectCache { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.ProjectCache resource property to the template. + Adds an AWS::CodeBuild::Project.ProjectCache resource property to the template. ProjectCache is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about the cache for the build project. .DESCRIPTION Adds an AWS::CodeBuild::Project.ProjectCache resource property to the template. - +ProjectCache is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about the cache for the build project. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html .PARAMETER Modes + If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time. ++ LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository GitHub, GitHub Enterprise, or Bitbucket, the option is ignored. ++ LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. +**Note** +You can use a Docker layer cache in the Linux environment only. +The privileged flag must be set so that your project has the required Docker permissions. +You should consider the security implications before you use a Docker layer cache. ++ LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: ++ Only directories can be specified for caching. You cannot specify individual files. ++ Symlinks are used to reference cached directories. ++ Cached directories are linked to your build before it downloads its project sources. Cached items are overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-modes UpdateType: Mutable .PARAMETER Type + The type of cache used by the build project. Valid values include: ++ NO_CACHE: The build project does not use any cache. ++ S3: The build project reads and writes from and to S3. ++ LOCAL: The build project stores a cache locally on a build host that is only available to that build host. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-type PrimitiveType: String UpdateType: Mutable .PARAMETER Location + Information about the cache location: ++ NO_CACHE or LOCAL: This value is ignored. ++ S3: This is the S3 bucket name/prefix. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 new file mode 100644 index 000000000..ff29ff684 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 @@ -0,0 +1,118 @@ +function Add-VSCodeBuildProjectProjectFileSystemLocation { + <# + .SYNOPSIS + Adds an AWS::CodeBuild::Project.ProjectFileSystemLocation resource property to the template. + + .DESCRIPTION + Adds an AWS::CodeBuild::Project.ProjectFileSystemLocation resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html + + .PARAMETER MountPoint + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountpoint + PrimitiveType: String + UpdateType: Mutable + + .PARAMETER Type + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-type + PrimitiveType: String + UpdateType: Mutable + + .PARAMETER Identifier + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-identifier + PrimitiveType: String + UpdateType: Mutable + + .PARAMETER MountOptions + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountoptions + PrimitiveType: String + UpdateType: Mutable + + .PARAMETER Location + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-location + PrimitiveType: String + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.CodeBuild.Project.ProjectFileSystemLocation')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $MountPoint, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Type, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Identifier, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $MountOptions, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Location + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.CodeBuild.Project.ProjectFileSystemLocation' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 index 542d988da..3f076da47 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 @@ -1,21 +1,30 @@ function Add-VSCodeBuildProjectProjectSourceVersion { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.ProjectSourceVersion resource property to the template. + Adds an AWS::CodeBuild::Project.ProjectSourceVersion resource property to the template. A source identifier and its corresponding version. .DESCRIPTION Adds an AWS::CodeBuild::Project.ProjectSourceVersion resource property to the template. - +A source identifier and its corresponding version. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html .PARAMETER SourceIdentifier + An identifier for a source in the build project. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html#cfn-codebuild-project-projectsourceversion-sourceidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER SourceVersion + The source version for the corresponding source identifier. If specified, must be one of: ++ For AWS CodeCommit: the commit ID to use. ++ For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID for example, pr/25. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. ++ For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. ++ For Amazon Simple Storage Service Amazon S3: the version ID of the object that represents the build input ZIP file to use. +For more information, see Source Version Sample with CodeBuild: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html in the *AWS CodeBuild User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html#cfn-codebuild-project-projectsourceversion-sourceversion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectTriggers.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectTriggers.ps1 index bd2f4417e..6b433f9fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectTriggers.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectTriggers.ps1 @@ -1,22 +1,26 @@ function Add-VSCodeBuildProjectProjectTriggers { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.ProjectTriggers resource property to the template. + Adds an AWS::CodeBuild::Project.ProjectTriggers resource property to the template. ProjectTriggers is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies webhooks that trigger an AWS CodeBuild build. .DESCRIPTION Adds an AWS::CodeBuild::Project.ProjectTriggers resource property to the template. - +ProjectTriggers is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies webhooks that trigger an AWS CodeBuild build. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html .PARAMETER FilterGroups + A list of lists of WebhookFilter objects used to determine which webhook events are triggered. At least one WebhookFilter in the array must specify EVENT as its type. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-filtergroups ItemType: FilterGroup UpdateType: Mutable .PARAMETER Webhook + Specifies whether or not to begin automatically rebuilding the source code every time a code change is pushed to the repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-webhook PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 index 5c2cd1921..a9ebe8c7d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 @@ -1,21 +1,32 @@ function Add-VSCodeBuildProjectRegistryCredential { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.RegistryCredential resource property to the template. + Adds an AWS::CodeBuild::Project.RegistryCredential resource property to the template. RegistryCredential is a property of the AWS CodeBuild Project Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html property type that specifies information about credentials that provide access to a private Docker registry. When this is set: .DESCRIPTION Adds an AWS::CodeBuild::Project.RegistryCredential resource property to the template. +RegistryCredential is a property of the AWS CodeBuild Project Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html property type that specifies information about credentials that provide access to a private Docker registry. When this is set: ++ imagePullCredentialsType must be set to SERVICE_ROLE. + ++ images cannot be curated or an Amazon ECR image. + +For more information, see Private Registry with AWS Secrets Manager Sample for AWS CodeBuild: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html .PARAMETER Credential + The Amazon Resource Name ARN or name of credentials created using AWS Secrets Manager. +The credential can use the name of the credentials only if they exist in your current region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credential PrimitiveType: String UpdateType: Mutable .PARAMETER CredentialProvider + The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credentialprovider PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectS3LogsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectS3LogsConfig.ps1 index 4fc80bb7d..53d413ac0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectS3LogsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectS3LogsConfig.ps1 @@ -1,26 +1,34 @@ function Add-VSCodeBuildProjectS3LogsConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.S3LogsConfig resource property to the template. + Adds an AWS::CodeBuild::Project.S3LogsConfig resource property to the template. S3Logs is a property of the AWS CodeBuild Project LogsConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket. .DESCRIPTION Adds an AWS::CodeBuild::Project.S3LogsConfig resource property to the template. - +S3Logs is a property of the AWS CodeBuild Project LogsConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html .PARAMETER Status + The current status of the S3 build logs. Valid values are: ++ ENABLED: S3 build logs are enabled for this build project. ++ DISABLED: S3 build logs are not enabled for this build project. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-status PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionDisabled + Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-encryptiondisabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Location + The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 index 45f77d9da..c2cf45436 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 @@ -1,56 +1,89 @@ function Add-VSCodeBuildProjectSource { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.Source resource property to the template. + Adds an AWS::CodeBuild::Project.Source resource property to the template. Source is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies the source code settings for the project, such as the source code's repository type and location. .DESCRIPTION Adds an AWS::CodeBuild::Project.Source resource property to the template. - +Source is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies the source code settings for the project, such as the source code's repository type and location. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html .PARAMETER Type + The type of repository that contains the source code to be built. Valid values include: ++ BITBUCKET: The source code is in a Bitbucket repository. ++ CODECOMMIT: The source code is in an AWS CodeCommit repository. ++ CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. ++ GITHUB: The source code is in a GitHub repository. ++ NO_SOURCE: The project does not have input source code. ++ S3: The source code is in an Amazon Simple Storage Service Amazon S3 input bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-type PrimitiveType: String UpdateType: Mutable .PARAMETER ReportBuildStatus + Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-reportbuildstatus PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Auth + Information about the authorization settings for AWS CodeBuild to access the source code to be built. +This information is for the AWS CodeBuild console's use only. Your code should not get or set Auth directly. + Type: SourceAuth Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-auth UpdateType: Mutable .PARAMETER SourceIdentifier + An identifier for this project source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-sourceidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER BuildSpec + The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named buildspec.yml at the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variable CODEBUILD_SRC_DIR. The alternate buildspec file can have a name other than buildspec.yml, for example myspec.yml or build_spec_qa.yml or similar. For more information, see the Build Spec Reference: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example in the *AWS CodeBuild User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildspec PrimitiveType: String UpdateType: Mutable .PARAMETER GitCloneDepth + The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitclonedepth PrimitiveType: Integer UpdateType: Mutable .PARAMETER GitSubmodulesConfig + Information about the Git submodules configuration for the build project. + Type: GitSubmodulesConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitsubmodulesconfig UpdateType: Mutable .PARAMETER InsecureSsl + This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is false. InsecureSsl should be used for testing purposes only. It should not be used in a production environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-insecuressl PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Location + Information about the location of the source code to be built. Valid values include: ++ For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. ++ For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name . ++ For source code in an Amazon Simple Storage Service Amazon S3 input bucket, one of the following. ++ The path to the ZIP file that contains the source code for example, bucket-name/path/to/object-name.zip. ++ The path to the folder that contains the source code for example, bucket-name/path/to/source-code/folder/. ++ For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect or reconnect with GitHub, on the GitHub **Authorize application** page, for **Organization access**, choose **Request access** next to each repository you want to allow AWS CodeBuild to have access to, and then choose **Authorize application**. After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console. To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. ++ For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect or reconnect with Bitbucket, on the Bitbucket **Confirm access to your account** page, choose **Grant access**. After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console. To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. +If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSourceAuth.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSourceAuth.ps1 index eb8ee20b8..9288bf15f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSourceAuth.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSourceAuth.ps1 @@ -1,21 +1,29 @@ function Add-VSCodeBuildProjectSourceAuth { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.SourceAuth resource property to the template. + Adds an AWS::CodeBuild::Project.SourceAuth resource property to the template. SourceAuth is a property of the AWS CodeBuild Project Source : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html property type that specifies authorization settings for AWS CodeBuild to access the source code to be built. .DESCRIPTION Adds an AWS::CodeBuild::Project.SourceAuth resource property to the template. +SourceAuth is a property of the AWS CodeBuild Project Source : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html property type that specifies authorization settings for AWS CodeBuild to access the source code to be built. +SourceAuth is for use by the CodeBuild console only. Do not get or set it directly. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html .PARAMETER Type + The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type. +This data type is used by the AWS CodeBuild console only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-type PrimitiveType: String UpdateType: Mutable .PARAMETER Resource + The resource value that applies to the specified authorization type. +This data type is used by the AWS CodeBuild console only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-resource PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectVpcConfig.ps1 index 864abedad..d3733e493 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectVpcConfig.ps1 @@ -1,27 +1,33 @@ function Add-VSCodeBuildProjectVpcConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.VpcConfig resource property to the template. + Adds an AWS::CodeBuild::Project.VpcConfig resource property to the template. VpcConfig is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud: https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html in the *AWS CodeBuild User Guide*. .DESCRIPTION Adds an AWS::CodeBuild::Project.VpcConfig resource property to the template. - +VpcConfig is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud: https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html in the *AWS CodeBuild User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html .PARAMETER Subnets + A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-subnets UpdateType: Mutable .PARAMETER VpcId + The ID of the Amazon VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-vpcid PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroupIds + A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-securitygroupids diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectWebhookFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectWebhookFilter.ps1 index 03437211b..0baff518e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectWebhookFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectWebhookFilter.ps1 @@ -1,26 +1,47 @@ function Add-VSCodeBuildProjectWebhookFilter { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.WebhookFilter resource property to the template. + Adds an AWS::CodeBuild::Project.WebhookFilter resource property to the template. WebhookFilter is a structure of the FilterGroups property on the AWS CodeBuild Project ProjectTriggers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html property type that specifies which webhooks trigger an AWS CodeBuild build. .DESCRIPTION Adds an AWS::CodeBuild::Project.WebhookFilter resource property to the template. - +WebhookFilter is a structure of the FilterGroups property on the AWS CodeBuild Project ProjectTriggers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html property type that specifies which webhooks trigger an AWS CodeBuild build. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html .PARAMETER Pattern + For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build. +For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-pattern PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH. +EVENT +A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events. +The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. +ACTOR_ACCOUNT_ID +A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern. +HEAD_REF +A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name. +Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. +BASE_REF +A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name. +Works with pull request events only. +FILE_PATH +A webhook triggers a build when the path of a changed file matches the regular expression pattern. +Works with GitHub and GitHub Enterprise push events only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-type PrimitiveType: String UpdateType: Mutable .PARAMETER ExcludeMatchedPattern + Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-excludematchedpattern PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryCode.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryCode.ps1 index 813c0d2b0..12939da96 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryCode.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryCode.ps1 @@ -1,16 +1,18 @@ function Add-VSCodeCommitRepositoryCode { <# .SYNOPSIS - Adds an AWS::CodeCommit::Repository.Code resource property to the template. + Adds an AWS::CodeCommit::Repository.Code resource property to the template. Information about code to be committed. .DESCRIPTION Adds an AWS::CodeCommit::Repository.Code resource property to the template. - +Information about code to be committed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-code.html .PARAMETER S3 + Information about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository. + Type: S3 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-code.html#cfn-codecommit-repository-code-s3 UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 index de792d2c3..1d2f15304 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 @@ -1,38 +1,50 @@ function Add-VSCodeCommitRepositoryRepositoryTrigger { <# .SYNOPSIS - Adds an AWS::CodeCommit::Repository.RepositoryTrigger resource property to the template. + Adds an AWS::CodeCommit::Repository.RepositoryTrigger resource property to the template. Information about a trigger for a repository. .DESCRIPTION Adds an AWS::CodeCommit::Repository.RepositoryTrigger resource property to the template. - +Information about a trigger for a repository. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html .PARAMETER Events + The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon SNS. +The valid value "all" cannot be used with any other values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-events UpdateType: Mutable .PARAMETER Branches + The branches that will be included in the trigger configuration. If you specify an empty array, the trigger will apply to all branches. +Although no content is required in the array, you must include the array itself. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-branches UpdateType: Mutable .PARAMETER CustomData + Any custom data associated with the trigger that will be included in the information sent to the target of the trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-customdata PrimitiveType: String UpdateType: Mutable .PARAMETER DestinationArn + The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon SNS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-destinationarn PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryS3.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryS3.ps1 index 577db234f..90617825c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryS3.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryS3.ps1 @@ -1,26 +1,32 @@ function Add-VSCodeCommitRepositoryS3 { <# .SYNOPSIS - Adds an AWS::CodeCommit::Repository.S3 resource property to the template. + Adds an AWS::CodeCommit::Repository.S3 resource property to the template. Information about the Amazon S3 bucket that contains the code that will be committed to the new repository. .DESCRIPTION Adds an AWS::CodeCommit::Repository.S3 resource property to the template. - +Information about the Amazon S3 bucket that contains the code that will be committed to the new repository. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html .PARAMETER ObjectVersion + The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html#cfn-codecommit-repository-s3-objectversion PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket + The name of the Amazon S3 bucket that contains the ZIP file with the content that will be committed to the new repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html#cfn-codecommit-repository-s3-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key to use for accessing the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html#cfn-codecommit-repository-s3-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentConfigMinimumHealthyHosts.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentConfigMinimumHealthyHosts.ps1 index 4b215fc20..fecc3c255 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentConfigMinimumHealthyHosts.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentConfigMinimumHealthyHosts.ps1 @@ -1,21 +1,30 @@ function Add-VSCodeDeployDeploymentConfigMinimumHealthyHosts { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts resource property to the template. + Adds an AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts resource property to the template. MinimumHealthyHosts is a property of the DeploymentConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts resource property to the template. - +MinimumHealthyHosts is a property of the DeploymentConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html .PARAMETER Type + The minimum healthy instance type: ++ HOST_COUNT: The minimum number of healthy instance as an absolute value. ++ FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment. +In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails. +In a call to GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT. In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful. +For more information, see AWS CodeDeploy Instance Health: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html in the *AWS CodeDeploy User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The minimum healthy instance value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-value PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarm.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarm.ps1 index 51c0dac36..1872e0490 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarm.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarm.ps1 @@ -1,16 +1,18 @@ function Add-VSCodeDeployDeploymentGroupAlarm { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.Alarm resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.Alarm resource property to the template. The Alarm property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group. The Alarm property of the CodeDeploy DeploymentGroup AlarmConfiguration : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html property contains a list of Alarm property types. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.Alarm resource property to the template. - +The Alarm property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group. The Alarm property of the CodeDeploy DeploymentGroup AlarmConfiguration : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html property contains a list of Alarm property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html .PARAMETER Name + The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html#cfn-codedeploy-deploymentgroup-alarm-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarmConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarmConfiguration.ps1 index 96f783496..98549a699 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarmConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAlarmConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSCodeDeployDeploymentGroupAlarmConfiguration { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration resource property to the template. The AlarmConfiguration property type configuresCloudWatch alarms for an AWS CodeDeploy deployment group. AlarmConfiguration is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration resource property to the template. - +The AlarmConfiguration property type configuresCloudWatch alarms for an AWS CodeDeploy deployment group. AlarmConfiguration is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html .PARAMETER Alarms + A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-alarms DuplicatesAllowed: False ItemType: Alarm @@ -18,11 +20,17 @@ function Add-VSCodeDeployDeploymentGroupAlarmConfiguration { UpdateType: Mutable .PARAMETER Enabled + Indicates whether the alarm configuration is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IgnorePollAlarmFailure + Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false. ++ true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch. ++ false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-ignorepollalarmfailure PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAutoRollbackConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAutoRollbackConfiguration.ps1 index a9b624d6c..235993be3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAutoRollbackConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupAutoRollbackConfiguration.ps1 @@ -1,21 +1,27 @@ function Add-VSCodeDeployDeploymentGroupAutoRollbackConfiguration { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration resource property to the template. The AutoRollbackConfiguration property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully. For more information, see Automatic Rollbacks: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployments-rollback-and-redeploy.html#deployments-rollback-and-redeploy-automatic-rollbacks in the *AWS CodeDeploy User Guide*. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration resource property to the template. +The AutoRollbackConfiguration property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully. For more information, see Automatic Rollbacks: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployments-rollback-and-redeploy.html#deployments-rollback-and-redeploy-automatic-rollbacks in the *AWS CodeDeploy User Guide*. +AutoRollbackConfiguration is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html .PARAMETER Enabled + Indicates whether a defined automatic rollback configuration is currently enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Events + The event type or types that trigger a rollback. Valid values are DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, or DEPLOYMENT_STOP_ON_REQUEST. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-events DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeployment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeployment.ps1 index a5bf040b0..4c7986043 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeployment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeployment.ps1 @@ -1,26 +1,35 @@ function Add-VSCodeDeployDeploymentGroupDeployment { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.Deployment resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.Deployment resource property to the template. Deployment is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.Deployment resource property to the template. - +Deployment is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html .PARAMETER Description + A comment about the deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-description PrimitiveType: String UpdateType: Mutable .PARAMETER IgnoreApplicationStopFailures + If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop. +If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. +During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. All other scripts are run from the AppSpec file in the current deployment. If one of these scripts contains an error and does not run successfully, the deployment can fail. +If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-ignoreapplicationstopfailures PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Revision + Information about the location of stored application artifacts and the service from which to retrieve them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision Type: RevisionLocation UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 index d2550be1d..83e643215 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 @@ -1,21 +1,26 @@ function Add-VSCodeDeployDeploymentGroupDeploymentStyle { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.DeploymentStyle resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.DeploymentStyle resource property to the template. Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.DeploymentStyle resource property to the template. - +Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html .PARAMETER DeploymentOption + Indicates whether to route deployment traffic behind a load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymentoption PrimitiveType: String UpdateType: Mutable .PARAMETER DeploymentType + Indicates whether to run an in-place or blue/green deployment. +AWS CloudFormation supports blue/green deployments on AWS Lambda compute platforms only. For more information about deploying on an AWS Lambda compute platform, see Deployments on an AWS Lambda Compute Platform: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-steps.html#deployment-steps-lambda in the *AWS CodeDeploy User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymenttype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagFilter.ps1 index 926604336..ef877447d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagFilter.ps1 @@ -1,26 +1,37 @@ function Add-VSCodeDeployDeploymentGroupEC2TagFilter { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagFilter resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagFilter resource property to the template. Information about an EC2 tag filter. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagFilter resource property to the template. +Information about an EC2 tag filter. +For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html in the *AWS CodeDeploy User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html .PARAMETER Key + The tag filter key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-key PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The tag filter type: ++ KEY_ONLY: Key only. ++ VALUE_ONLY: Value only. ++ KEY_AND_VALUE: Key and value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The tag filter value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSet.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSet.ps1 index 14a1536f6..3c51d9567 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSet.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSet.ps1 @@ -1,16 +1,21 @@ function Add-VSCodeDeployDeploymentGroupEC2TagSet { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagSet resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagSet resource property to the template. The EC2TagSet property type specifies information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. EC2TagSet cannot be used in the same template as EC2TagFilter. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagSet resource property to the template. +The EC2TagSet property type specifies information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. EC2TagSet cannot be used in the same template as EC2TagFilter. +For information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html .PARAMETER Ec2TagSetList + The EC2 tags that are already applied to EC2 instances that you want to include in the deployment group. CodeDeploy includes all EC2 instances identified by any of the tags you specify in this deployment group. +Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html#cfn-codedeploy-deploymentgroup-ec2tagset-ec2tagsetlist DuplicatesAllowed: False ItemType: EC2TagSetListObject diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSetListObject.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSetListObject.ps1 index ae9ee5bc2..08df689b5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSetListObject.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupEC2TagSetListObject.ps1 @@ -1,16 +1,22 @@ function Add-VSCodeDeployDeploymentGroupEC2TagSetListObject { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject resource property to the template. The EC2TagSet property type specifies information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same template as EC2TagFilters. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject resource property to the template. +The EC2TagSet property type specifies information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same template as EC2TagFilters. +For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html in the *AWS CodeDeploy User Guide*. + +EC2TagSet is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html .PARAMETER Ec2TagGroup + A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html#cfn-codedeploy-deploymentgroup-ec2tagsetlistobject-ec2taggroup DuplicatesAllowed: False ItemType: EC2TagFilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupELBInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupELBInfo.ps1 index a71b5e640..6be206dd4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupELBInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupELBInfo.ps1 @@ -1,16 +1,23 @@ function Add-VSCodeDeployDeploymentGroupELBInfo { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.ELBInfo resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.ELBInfo resource property to the template. The ELBInfo property type specifies information about the Elastic Load Balancing load balancer used for an AWS CodeDelpoy deployment group. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.ELBInfo resource property to the template. +The ELBInfo property type specifies information about the Elastic Load Balancing load balancer used for an AWS CodeDelpoy deployment group. +If you specify the ELBInfo property, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for AWS CodeDeploy to route your traffic using the specified load balancers. + +ELBInfo is a property of the AWS CodeDeploy DeploymentGroup LoadBalancerInfo : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html .PARAMETER Name + For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. +AWS CloudFormation supports blue/green deployments on AWS Lambda compute platforms only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html#cfn-codedeploy-deploymentgroup-elbinfo-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupGitHubLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupGitHubLocation.ps1 index 29e8557b8..5a8be433c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupGitHubLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupGitHubLocation.ps1 @@ -1,21 +1,26 @@ function Add-VSCodeDeployDeploymentGroupGitHubLocation { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.GitHubLocation resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.GitHubLocation resource property to the template. GitHubLocation is a property of the CodeDeploy DeploymentGroup Revision: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html property that specifies the location of an application revision that is stored in GitHub. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.GitHubLocation resource property to the template. - +GitHubLocation is a property of the CodeDeploy DeploymentGroup Revision: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html property that specifies the location of an application revision that is stored in GitHub. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html .PARAMETER CommitId + The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-commitid PrimitiveType: String UpdateType: Mutable .PARAMETER Repository + The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. +Specify the value as account/repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-repository PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 index 8c32eb710..d8c3d99ac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 @@ -1,16 +1,27 @@ function Add-VSCodeDeployDeploymentGroupLoadBalancerInfo { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo resource property to the template. The LoadBalancerInfo property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group. For more information, see Integrating CodeDeploy with Elastic Load Balancing : https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html in the *AWS CodeDeploy User Guide*. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo resource property to the template. +The LoadBalancerInfo property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group. For more information, see Integrating CodeDeploy with Elastic Load Balancing : https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html in the *AWS CodeDeploy User Guide*. +For AWS CloudFormation to use the properties specified in LoadBalancerInfo, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL. If DeploymentStyle.DeploymentOption is not set to WITH_TRAFFIC_CONTROL, AWS CloudFormation ignores any settings specified in LoadBalancerInfo. + +**Note** + +AWS CloudFormation supports blue/green deployments on EC2/On-premises compute platforms only. + +LoadBalancerInfo is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html .PARAMETER ElbInfoList + An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers. +Adding more than one load balancer to the array is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-elbinfolist DuplicatesAllowed: False ItemType: ELBInfo @@ -18,6 +29,9 @@ function Add-VSCodeDeployDeploymentGroupLoadBalancerInfo { UpdateType: Mutable .PARAMETER TargetGroupInfoList + An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers. +Adding more than one target group to the array is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgroupinfolist DuplicatesAllowed: False ItemType: TargetGroupInfo diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSet.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSet.ps1 index 59f3ab12d..8a5235ed5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSet.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSet.ps1 @@ -1,16 +1,23 @@ function Add-VSCodeDeployDeploymentGroupOnPremisesTagSet { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet resource property to the template. The OnPremisesTagSet property type specifies a list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet resource property to the template. +The OnPremisesTagSet property type specifies a list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list. +For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html in the *AWS CodeDeploy User Guide*. + +OnPremisesTagSet is a property of the DeploymentGroup : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html .PARAMETER OnPremisesTagSetList + A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list. +Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html#cfn-codedeploy-deploymentgroup-onpremisestagset-onpremisestagsetlist DuplicatesAllowed: False ItemType: OnPremisesTagSetListObject diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSetListObject.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSetListObject.ps1 index 3e03df388..6ec4b617b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSetListObject.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupOnPremisesTagSetListObject.ps1 @@ -1,16 +1,20 @@ function Add-VSCodeDeployDeploymentGroupOnPremisesTagSetListObject { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject resource property to the template. The OnPremisesTagSetListObject property type specifies lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject resource property to the template. +The OnPremisesTagSetListObject property type specifies lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list. +OnPremisesTagSetListObject is a property of the CodeDeploy DeploymentGroup OnPremisesTagSet: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html .PARAMETER OnPremisesTagGroup + Information about groups of on-premises instance tags. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html#cfn-codedeploy-deploymentgroup-onpremisestagsetlistobject-onpremisestaggroup DuplicatesAllowed: False ItemType: TagFilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 index 631ca8347..796dd1f50 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 @@ -1,26 +1,35 @@ function Add-VSCodeDeployDeploymentGroupRevisionLocation { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.RevisionLocation resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.RevisionLocation resource property to the template. RevisionLocation is a property that defines the location of the CodeDeploy application revision to deploy. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.RevisionLocation resource property to the template. - +RevisionLocation is a property that defines the location of the CodeDeploy application revision to deploy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html .PARAMETER GitHubLocation + Information about the location of application artifacts stored in GitHub. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation Type: GitHubLocation UpdateType: Mutable .PARAMETER RevisionType + The type of application revision: ++ S3: An application revision stored in Amazon S3. ++ GitHub: An application revision stored in GitHub EC2/On-premises deployments only. ++ String: A YAML-formatted or JSON-formatted string AWS Lambda deployments only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-revisiontype PrimitiveType: String UpdateType: Mutable .PARAMETER S3Location + Information about the location of a revision stored in Amazon S3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location Type: S3Location UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupS3Location.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupS3Location.ps1 index 6e77e2f7c..9f85c966d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupS3Location.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupS3Location.ps1 @@ -1,36 +1,53 @@ function Add-VSCodeDeployDeploymentGroupS3Location { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.S3Location resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.S3Location resource property to the template. S3Location is a property of the CodeDeploy DeploymentGroup Revision : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html property that specifies the location of an application revision that is stored in Amazon Simple Storage Service (S3. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.S3Location resource property to the template. - +S3Location is a property of the CodeDeploy DeploymentGroup Revision : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html property that specifies the location of an application revision that is stored in Amazon Simple Storage Service (S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html .PARAMETER Bucket + The name of the Amazon S3 bucket where the application revision is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER BundleType + The file type of the application revision. Must be one of the following: ++ JSON ++ tar: A tar archive file. ++ tgz: A compressed tar archive file. ++ YAML ++ zip: A zip archive file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bundletype PrimitiveType: String UpdateType: Mutable .PARAMETER ETag + The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. +If the ETag is not specified as an input parameter, ETag validation of the object is skipped. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-etag PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The name of the Amazon S3 object that represents the bundled artifacts for the application revision. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-key PrimitiveType: String UpdateType: Mutable .PARAMETER Version + A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. +If the version is not specified, the system uses the most recent version by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTagFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTagFilter.ps1 index dee499fd6..09e3f7cbb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTagFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTagFilter.ps1 @@ -1,26 +1,37 @@ function Add-VSCodeDeployDeploymentGroupTagFilter { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.TagFilter resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.TagFilter resource property to the template. TagFilter is a property type of the AWS::CodeDeploy::DeploymentGroup : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource that specifies which on-premises instances to associate with the deployment group. To register on-premise instances with AWS CodeDeploy, see Configure Existing On-Premises Instances by Using AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html in the *AWS CodeDeploy User Guide*. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.TagFilter resource property to the template. +TagFilter is a property type of the AWS::CodeDeploy::DeploymentGroup : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource that specifies which on-premises instances to associate with the deployment group. To register on-premise instances with AWS CodeDeploy, see Configure Existing On-Premises Instances by Using AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html in the *AWS CodeDeploy User Guide*. +For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html in the *AWS CodeDeploy User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html .PARAMETER Key + The on-premises instance tag filter key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-key PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The on-premises instance tag filter type: ++ KEY_ONLY: Key only. ++ VALUE_ONLY: Value only. ++ KEY_AND_VALUE: Key and value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The on-premises instance tag filter value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTargetGroupInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTargetGroupInfo.ps1 index 418605326..e9588828f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTargetGroupInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTargetGroupInfo.ps1 @@ -1,16 +1,24 @@ function Add-VSCodeDeployDeploymentGroupTargetGroupInfo { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo resource property to the template. The TargetGroupInfo property type specifies information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see TargetGroupInfo: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_TargetGroupInfo.html in the *AWS CodeDeploy API Reference* .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo resource property to the template. +The TargetGroupInfo property type specifies information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see TargetGroupInfo: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_TargetGroupInfo.html in the *AWS CodeDeploy API Reference* +If you specify the TargetGroupInfo property, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for CodeDeploy to route your traffic using the specified target groups. + +TargetGroupInfo is a property of the LoadBalancerInfo: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html .PARAMETER Name + For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. No duplicates allowed. +AWS CloudFormation supports blue/green deployments on AWS Lambda compute platforms only. +This value cannot exceed 32 characters, so you should use the Name property of the target group, or the TargetGroupName attribute with the Fn::GetAtt intrinsic function, as shown in the following example. Don't use the group's Amazon Resource Name ARN or TargetGroupFullName attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html#cfn-codedeploy-deploymentgroup-targetgroupinfo-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTriggerConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTriggerConfig.ps1 index 583ca462a..75c57616b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTriggerConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupTriggerConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSCodeDeployDeploymentGroupTriggerConfig { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup.TriggerConfig resource property to the template. + Adds an AWS::CodeDeploy::DeploymentGroup.TriggerConfig resource property to the template. Information about notification triggers for the deployment group. .DESCRIPTION Adds an AWS::CodeDeploy::DeploymentGroup.TriggerConfig resource property to the template. - +Information about notification triggers for the deployment group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html .PARAMETER TriggerEvents + The event type or types that trigger notifications. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggerevents DuplicatesAllowed: False PrimitiveItemType: String @@ -18,11 +20,15 @@ function Add-VSCodeDeployDeploymentGroupTriggerConfig { UpdateType: Mutable .PARAMETER TriggerName + The name of the notification trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggername PrimitiveType: String UpdateType: Mutable .PARAMETER TriggerTargetArn + The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggertargetarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeArtifactDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeArtifactDetails.ps1 index 84af50806..4d3a4ed4b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeArtifactDetails.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeArtifactDetails.ps1 @@ -1,21 +1,25 @@ function Add-VSCodePipelineCustomActionTypeArtifactDetails { <# .SYNOPSIS - Adds an AWS::CodePipeline::CustomActionType.ArtifactDetails resource property to the template. + Adds an AWS::CodePipeline::CustomActionType.ArtifactDetails resource property to the template. Returns information about the details of an artifact. .DESCRIPTION Adds an AWS::CodePipeline::CustomActionType.ArtifactDetails resource property to the template. - +Returns information about the details of an artifact. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html .PARAMETER MaximumCount + The maximum number of artifacts allowed for the action type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinimumCount + The minimum number of artifacts allowed for the action type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 index bfd3993f1..768117c2b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 @@ -1,46 +1,66 @@ function Add-VSCodePipelineCustomActionTypeConfigurationProperties { <# .SYNOPSIS - Adds an AWS::CodePipeline::CustomActionType.ConfigurationProperties resource property to the template. + Adds an AWS::CodePipeline::CustomActionType.ConfigurationProperties resource property to the template. The configuration properties for the custom action. .DESCRIPTION Adds an AWS::CodePipeline::CustomActionType.ConfigurationProperties resource property to the template. +The configuration properties for the custom action. +**Note** + +You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html .PARAMETER Description + The description of the action configuration property that will be displayed to users. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description PrimitiveType: String UpdateType: Mutable .PARAMETER Key + Whether the configuration property is a key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The name of the action configuration property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name PrimitiveType: String UpdateType: Mutable .PARAMETER Queryable + Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. +If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty 20 characters. The value can contain only alphanumeric characters, underscores, and hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Required + Whether the configuration property is a required value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Secret + Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. +When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Type + The type of the configuration property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 index a12a8c558..03029b605 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 @@ -1,31 +1,39 @@ function Add-VSCodePipelineCustomActionTypeSettings { <# .SYNOPSIS - Adds an AWS::CodePipeline::CustomActionType.Settings resource property to the template. + Adds an AWS::CodePipeline::CustomActionType.Settings resource property to the template. Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action. .DESCRIPTION Adds an AWS::CodePipeline::CustomActionType.Settings resource property to the template. - +Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html .PARAMETER EntityUrlTemplate + The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ExecutionUrlTemplate + The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate PrimitiveType: String UpdateType: Mutable .PARAMETER RevisionUrlTemplate + The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ThirdPartyConfigurationUrl + The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 index 8dbac791e..a5c6ba8cb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 @@ -1,26 +1,32 @@ function Add-VSCodePipelinePipelineActionDeclaration { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.ActionDeclaration resource property to the template. + Adds an AWS::CodePipeline::Pipeline.ActionDeclaration resource property to the template. Represents information about an action declaration. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.ActionDeclaration resource property to the template. - +Represents information about an action declaration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html .PARAMETER ActionTypeId + The configuration information for the action type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid Type: ActionTypeId UpdateType: Mutable .PARAMETER Configuration + The action declaration's configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration PrimitiveType: Json UpdateType: Mutable .PARAMETER InputArtifacts + The name or ID of the artifact consumed by the action, such as a test or build artifact. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts DuplicatesAllowed: False ItemType: InputArtifact @@ -28,16 +34,22 @@ function Add-VSCodePipelinePipelineActionDeclaration { UpdateType: Mutable .PARAMETER Name + The action declaration's name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-actiondeclaration-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER OutputArtifacts + The name or ID of the result of the action declaration, such as a test or build artifact. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts DuplicatesAllowed: False ItemType: OutputArtifact @@ -45,16 +57,22 @@ function Add-VSCodePipelinePipelineActionDeclaration { UpdateType: Mutable .PARAMETER Region + The action declaration's AWS Region, such as us-east-1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-region PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER RunOrder + The order in which actions are run. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 index 1cd4952c3..661e7a32b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 @@ -1,31 +1,39 @@ function Add-VSCodePipelinePipelineActionTypeId { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.ActionTypeId resource property to the template. + Adds an AWS::CodePipeline::Pipeline.ActionTypeId resource property to the template. Represents information about an action type. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.ActionTypeId resource property to the template. - +Represents information about an action type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html .PARAMETER Category + A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category PrimitiveType: String UpdateType: Mutable .PARAMETER Owner + The creator of the action being called. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner PrimitiveType: String UpdateType: Mutable .PARAMETER Provider + The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider PrimitiveType: String UpdateType: Mutable .PARAMETER Version + A string that describes the action version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 index 657ea01ce..b25fbe4b6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 @@ -1,26 +1,32 @@ function Add-VSCodePipelinePipelineArtifactStore { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.ArtifactStore resource property to the template. + Adds an AWS::CodePipeline::Pipeline.ArtifactStore resource property to the template. The Amazon S3 bucket where artifacts are stored for the pipeline. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.ArtifactStore resource property to the template. - +The Amazon S3 bucket where artifacts are stored for the pipeline. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html .PARAMETER EncryptionKey + The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service AWS KMS key. If this is undefined, the default key for Amazon S3 is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey Type: EncryptionKey UpdateType: Mutable .PARAMETER Location + The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of the artifact store, such as S3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 index 1bfe5d03c..781580e29 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 @@ -1,21 +1,27 @@ function Add-VSCodePipelinePipelineArtifactStoreMap { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.ArtifactStoreMap resource property to the template. + Adds an AWS::CodePipeline::Pipeline.ArtifactStoreMap resource property to the template. A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.ArtifactStoreMap resource property to the template. +A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. +If you create a cross-region action in your pipeline, you must use artifactStores. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html .PARAMETER ArtifactStore + Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore Type: ArtifactStore UpdateType: Mutable .PARAMETER Region + The action declaration's AWS Region, such as us-east-1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-region PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineBlockerDeclaration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineBlockerDeclaration.ps1 index 3b2cecdf5..e05a7b7d5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineBlockerDeclaration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineBlockerDeclaration.ps1 @@ -1,21 +1,25 @@ function Add-VSCodePipelinePipelineBlockerDeclaration { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.BlockerDeclaration resource property to the template. + Adds an AWS::CodePipeline::Pipeline.BlockerDeclaration resource property to the template. Reserved for future use. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.BlockerDeclaration resource property to the template. - +Reserved for future use. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html .PARAMETER Name + Reserved for future use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-name PrimitiveType: String UpdateType: Mutable .PARAMETER Type + Reserved for future use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 index 9bd3da105..c20e5f5ec 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 @@ -1,21 +1,25 @@ function Add-VSCodePipelinePipelineEncryptionKey { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.EncryptionKey resource property to the template. + Adds an AWS::CodePipeline::Pipeline.EncryptionKey resource property to the template. Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS key. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.EncryptionKey resource property to the template. - +Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS key. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html .PARAMETER Id + The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of encryption key, such as an AWS Key Management Service AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 index ff9b6cd6d..49a69e20a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 @@ -1,16 +1,19 @@ function Add-VSCodePipelinePipelineInputArtifact { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.InputArtifact resource property to the template. + Adds an AWS::CodePipeline::Pipeline.InputArtifact resource property to the template. Represents information about an artifact to be worked on, such as a test or build artifact. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.InputArtifact resource property to the template. - +Represents information about an artifact to be worked on, such as a test or build artifact. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html .PARAMETER Name + The name of the artifact to be worked on, for example, "My App". +The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineOutputArtifact.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineOutputArtifact.ps1 index cd25d11de..99e8da968 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineOutputArtifact.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineOutputArtifact.ps1 @@ -1,16 +1,20 @@ function Add-VSCodePipelinePipelineOutputArtifact { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.OutputArtifact resource property to the template. + Adds an AWS::CodePipeline::Pipeline.OutputArtifact resource property to the template. Represents information about the output of an action. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.OutputArtifact resource property to the template. - +Represents information about the output of an action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html .PARAMETER Name + The name of the output of an artifact, such as "My App". +The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. +Output artifact names must be unique within a pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageDeclaration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageDeclaration.ps1 index 9c8514710..0d427ca45 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageDeclaration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageDeclaration.ps1 @@ -1,16 +1,18 @@ function Add-VSCodePipelinePipelineStageDeclaration { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.StageDeclaration resource property to the template. + Adds an AWS::CodePipeline::Pipeline.StageDeclaration resource property to the template. Represents information about a stage and its definition. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.StageDeclaration resource property to the template. - +Represents information about a stage and its definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html .PARAMETER Actions + The actions included in a stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-actions DuplicatesAllowed: False ItemType: ActionDeclaration @@ -18,6 +20,8 @@ function Add-VSCodePipelinePipelineStageDeclaration { UpdateType: Mutable .PARAMETER Blockers + Reserved for future use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-blockers DuplicatesAllowed: False ItemType: BlockerDeclaration @@ -25,6 +29,8 @@ function Add-VSCodePipelinePipelineStageDeclaration { UpdateType: Mutable .PARAMETER Name + The name of the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 index d1d7a55b7..03b79de09 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 @@ -1,21 +1,25 @@ function Add-VSCodePipelinePipelineStageTransition { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.StageTransition resource property to the template. + Adds an AWS::CodePipeline::Pipeline.StageTransition resource property to the template. The name of the pipeline in which you want to disable the flow of artifacts from one stage to another. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.StageTransition resource property to the template. - +The name of the pipeline in which you want to disable the flow of artifacts from one stage to another. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html .PARAMETER Reason + The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason PrimitiveType: String UpdateType: Mutable .PARAMETER StageName + The name of the stage where you want to disable the inbound or outbound transition of artifacts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-stagename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 index 5280db764..b4437b3b8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSCodePipelineWebhookWebhookAuthConfiguration { <# .SYNOPSIS - Adds an AWS::CodePipeline::Webhook.WebhookAuthConfiguration resource property to the template. + Adds an AWS::CodePipeline::Webhook.WebhookAuthConfiguration resource property to the template. The authentication applied to incoming webhook trigger requests. .DESCRIPTION Adds an AWS::CodePipeline::Webhook.WebhookAuthConfiguration resource property to the template. - +The authentication applied to incoming webhook trigger requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html .PARAMETER AllowedIPRange + The property used to configure acceptance of webhooks within a specific IP range. For IP, only the AllowedIPRange property must be set, and this property must be set to a valid CIDR range. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange PrimitiveType: String UpdateType: Mutable .PARAMETER SecretToken + The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-secrettoken PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 index 5e5d344d1..1abfec385 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 @@ -1,21 +1,25 @@ function Add-VSCodePipelineWebhookWebhookFilterRule { <# .SYNOPSIS - Adds an AWS::CodePipeline::Webhook.WebhookFilterRule resource property to the template. + Adds an AWS::CodePipeline::Webhook.WebhookFilterRule resource property to the template. The event criteria that specify when a webhook notification is sent to your URL. .DESCRIPTION Adds an AWS::CodePipeline::Webhook.WebhookFilterRule resource property to the template. - +The event criteria that specify when a webhook notification is sent to your URL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html .PARAMETER JsonPath + A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field, otherwise the request will be ignored. For more information about JsonPath expressions, see Java JsonPath implementation: https://github.com/json-path/JsonPath in GitHub. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath PrimitiveType: String UpdateType: Mutable .PARAMETER MatchEquals + The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryCode.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryCode.ps1 index a1045f25a..ec790e7f4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryCode.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryCode.ps1 @@ -1,16 +1,20 @@ function Add-VSCodeStarGitHubRepositoryCode { <# .SYNOPSIS - Adds an AWS::CodeStar::GitHubRepository.Code resource property to the template. + Adds an AWS::CodeStar::GitHubRepository.Code resource property to the template. The Code property type specifies information about code to be committed. .DESCRIPTION Adds an AWS::CodeStar::GitHubRepository.Code resource property to the template. +The Code property type specifies information about code to be committed. +Code is a property of the AWS::CodeStar::GitHubRepository resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html .PARAMETER S3 + Information about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository. + Type: S3 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html#cfn-codestar-githubrepository-code-s3 UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryS3.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryS3.ps1 index a611b010a..2bb60a620 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryS3.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeStarGitHubRepositoryS3.ps1 @@ -1,26 +1,34 @@ function Add-VSCodeStarGitHubRepositoryS3 { <# .SYNOPSIS - Adds an AWS::CodeStar::GitHubRepository.S3 resource property to the template. + Adds an AWS::CodeStar::GitHubRepository.S3 resource property to the template. The S3 property type specifies information about the Amazon S3 bucket that contains the code to be committed to the new repository. .DESCRIPTION Adds an AWS::CodeStar::GitHubRepository.S3 resource property to the template. +The S3 property type specifies information about the Amazon S3 bucket that contains the code to be committed to the new repository. +S3 is a property of the AWS::CodeStar::GitHubRepository resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html .PARAMETER ObjectVersion + The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-objectversion PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket + The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The S3 object key or file name for the ZIP file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 index 7efe524ea..9d94e8c79 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 @@ -1,26 +1,34 @@ function Add-VSCognitoIdentityPoolCognitoIdentityProvider { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPool.CognitoIdentityProvider resource property to the template. + Adds an AWS::Cognito::IdentityPool.CognitoIdentityProvider resource property to the template. CognitoIdentityProvider is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html resource that represents an Amazon Cognito user pool and its client ID. .DESCRIPTION Adds an AWS::Cognito::IdentityPool.CognitoIdentityProvider resource property to the template. - +CognitoIdentityProvider is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html resource that represents an Amazon Cognito user pool and its client ID. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html .PARAMETER ServerSideTokenCheck + TRUE if server-side token validation is enabled for the identity provider’s token. +Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. +If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-serversidetokencheck PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ProviderName + The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-providername PrimitiveType: String UpdateType: Mutable .PARAMETER ClientId + The client ID for the Amazon Cognito user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-clientid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 index 80d673324..f41e5f3e5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 @@ -1,26 +1,32 @@ function Add-VSCognitoIdentityPoolCognitoStreams { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPool.CognitoStreams resource property to the template. + Adds an AWS::Cognito::IdentityPool.CognitoStreams resource property to the template. CognitoStreams is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html resource that defines configuration options for Amazon Cognito streams. .DESCRIPTION Adds an AWS::Cognito::IdentityPool.CognitoStreams resource property to the template. - +CognitoStreams is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html resource that defines configuration options for Amazon Cognito streams. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html .PARAMETER StreamingStatus + Status of the Amazon Cognito streams. Valid values are: ENABLED or DISABLED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamingstatus PrimitiveType: String UpdateType: Mutable .PARAMETER StreamName + The name of the Amazon Cognito stream to receive updates. This stream must be in the developer's account and in the same region as the identity pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the role Amazon Cognito can assume to publish to the stream. This role must grant access to Amazon Cognito cognito-sync to invoke PutRecord on your Amazon Cognito stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 index 266cdbbe7..a04e5da87 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 @@ -1,22 +1,26 @@ function Add-VSCognitoIdentityPoolPushSync { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPool.PushSync resource property to the template. + Adds an AWS::Cognito::IdentityPool.PushSync resource property to the template. PushSync is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html resource that defines the configuration options to be applied to an Amazon Cognito identity pool. .DESCRIPTION Adds an AWS::Cognito::IdentityPool.PushSync resource property to the template. - +PushSync is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html resource that defines the configuration options to be applied to an Amazon Cognito identity pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html .PARAMETER ApplicationArns + List of Amazon SNS platform application ARNs that could be used by clients. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-applicationarns UpdateType: Mutable .PARAMETER RoleArn + An IAM role configured to allow Amazon Cognito to call SNS on behalf of the developer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 index 24a497201..9c5ee9ec9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 @@ -1,31 +1,40 @@ function Add-VSCognitoIdentityPoolRoleAttachmentMappingRule { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPoolRoleAttachment.MappingRule resource property to the template. + Adds an AWS::Cognito::IdentityPoolRoleAttachment.MappingRule resource property to the template. Defines how to map a claim to a role ARN. .DESCRIPTION Adds an AWS::Cognito::IdentityPoolRoleAttachment.MappingRule resource property to the template. - +Defines how to map a claim to a role ARN. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html .PARAMETER MatchType + The match condition that specifies how closely the claim value in the IdP token must match Value. +Valid values are: Equals, Contains, StartsWith, and NotEqual. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype PrimitiveType: String UpdateType: Mutable .PARAMETER Value + A brief string that the claim must match, for example, "paid" or "yes." + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value PrimitiveType: String UpdateType: Mutable .PARAMETER Claim + The claim name that must be present in the token, for example, "isAdmin" or "paid." + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The Amazon Resource Name ARN of the role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 index 030f53c0d..46f7622a9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 @@ -1,31 +1,41 @@ function Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping resource property to the template. + Adds an AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping resource property to the template. RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html resource that defines the role mapping attributes of an Amazon Cognito identity pool. .DESCRIPTION Adds an AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping resource property to the template. - +RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html resource that defines the role mapping attributes of an Amazon Cognito identity pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html .PARAMETER Type + The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Amazon Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role. +Valid values are Token or Rules. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-type PrimitiveType: String UpdateType: Mutable .PARAMETER AmbiguousRoleResolution + Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. If you specify Token or Rules as the Type, AmbiguousRoleResolution is required. +Valid values are AuthenticatedRole or Deny. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-ambiguousroleresolution PrimitiveType: String UpdateType: Mutable .PARAMETER RulesConfiguration + The rules to be used for mapping users to roles. If you specify Rules as the role mapping type, RulesConfiguration is required. + Type: RulesConfigurationType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-rulesconfiguration UpdateType: Mutable .PARAMETER IdentityProvider + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-identityprovider PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 index 036a2b263..ab0466a36 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType resource property to the template. + Adds an AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType resource property to the template. RulesConfigurationType is a subproperty of the RoleMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html property that defines the rules to be used for mapping users to roles. .DESCRIPTION Adds an AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType resource property to the template. - +RulesConfigurationType is a subproperty of the RoleMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html property that defines the rules to be used for mapping users to roles. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html .PARAMETER Rules + A list of rules. You can specify up to 25 rules per identity provider. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html#cfn-cognito-identitypoolroleattachment-rulesconfigurationtype-rules ItemType: MappingRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 index 151fdff0a..56c2c5529 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 @@ -1,26 +1,34 @@ function Add-VSCognitoUserPoolAdminCreateUserConfig { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.AdminCreateUserConfig resource property to the template. + Adds an AWS::Cognito::UserPool.AdminCreateUserConfig resource property to the template. AdminCreateUserConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource. The AdminCreateUserConfig property configures the AdminCreateUser requests for an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.AdminCreateUserConfig resource property to the template. - +AdminCreateUserConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource. The AdminCreateUserConfig property configures the AdminCreateUser requests for an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html .PARAMETER InviteMessageTemplate + The message template to be used for the welcome message to new users. +See also Customizing User Invitation Messages: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization. + Type: InviteMessageTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-invitemessagetemplate UpdateType: Mutable .PARAMETER UnusedAccountValidityDays + The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7. +If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays PrimitiveType: Integer UpdateType: Mutable .PARAMETER AllowAdminCreateUserOnly + Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 index d86f375bf..31152aeb5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 @@ -1,31 +1,39 @@ function Add-VSCognitoUserPoolClientAnalyticsConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolClient.AnalyticsConfiguration resource property to the template. + Adds an AWS::Cognito::UserPoolClient.AnalyticsConfiguration resource property to the template. AnalyticsConfiguration is a property of the AWS::Cognito::UserPoolClient: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html resource that defines the Amazon Pinpoint analytics configuration for collecting metrics for this user pool. .DESCRIPTION Adds an AWS::Cognito::UserPoolClient.AnalyticsConfiguration resource property to the template. - +AnalyticsConfiguration is a property of the AWS::Cognito::UserPoolClient: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html resource that defines the Amazon Pinpoint analytics configuration for collecting metrics for this user pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html .PARAMETER UserDataShared + If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-userdatashared PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExternalId + The external ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-externalid PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The application ID for an Amazon Pinpoint application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-applicationid PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 index 92264636c..c9b21487f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolDeviceConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.DeviceConfiguration resource property to the template. + Adds an AWS::Cognito::UserPool.DeviceConfiguration resource property to the template. DeviceConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the device configuration of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.DeviceConfiguration resource property to the template. - +DeviceConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the device configuration of an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html .PARAMETER DeviceOnlyRememberedOnUserPrompt + If true, a device is only remembered on user prompt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-deviceonlyrememberedonuserprompt PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ChallengeRequiredOnNewDevice + Indicates whether a challenge is required on a new device. Only applicable to a new device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-challengerequiredonnewdevice PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 index 941dc2488..3ab14bfb2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 @@ -1,36 +1,56 @@ function Add-VSCognitoUserPoolEmailConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.EmailConfiguration resource property to the template. + Adds an AWS::Cognito::UserPool.EmailConfiguration resource property to the template. EmailConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the email configuration of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.EmailConfiguration resource property to the template. - +EmailConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the email configuration of an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html .PARAMETER ReplyToEmailAddress + The destination to which the receiver of the email should reply to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-replytoemailaddress PrimitiveType: String UpdateType: Mutable .PARAMETER ConfigurationSet + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-configurationset PrimitiveType: String UpdateType: Mutable .PARAMETER EmailSendingAccount + Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values: +COGNITO_DEFAULT +When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration. +To look up the email delivery limit for the default option, see Limits in Amazon Cognito: https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html in the *Amazon Cognito Developer Guide*. +The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter. +DEVELOPER +When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account. +If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter. +Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a *service-linked role*, which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito: https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html in the *Amazon Cognito Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-emailsendingaccount PrimitiveType: String UpdateType: Mutable .PARAMETER SourceArn + The Amazon Resource Name ARN of a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter: ++ If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account. ++ If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-sourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER From + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-from PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 index 6b5f40f7c..304bf1ca1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 @@ -1,26 +1,34 @@ function Add-VSCognitoUserPoolInviteMessageTemplate { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.InviteMessageTemplate resource property to the template. + Adds an AWS::Cognito::UserPool.InviteMessageTemplate resource property to the template. InviteMessageTemplate is a subproperty of the AdminCreateUserConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html property that defines the email and SMS invitation message structure of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.InviteMessageTemplate resource property to the template. +InviteMessageTemplate is a subproperty of the AdminCreateUserConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html property that defines the email and SMS invitation message structure of an Amazon Cognito User Pool. +See also Customizing User Invitation Messages: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html .PARAMETER EmailMessage + The message template for email messages. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailmessage PrimitiveType: String UpdateType: Mutable .PARAMETER SMSMessage + The message template for SMS messages. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-smsmessage PrimitiveType: String UpdateType: Mutable .PARAMETER EmailSubject + The subject line for email messages. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailsubject PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 index a99b5cd23..d0a540d32 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 @@ -1,61 +1,89 @@ function Add-VSCognitoUserPoolLambdaConfig { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.LambdaConfig resource property to the template. + Adds an AWS::Cognito::UserPool.LambdaConfig resource property to the template. LambdaConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the AWS Lambda configuration of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.LambdaConfig resource property to the template. +LambdaConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the AWS Lambda configuration of an Amazon Cognito User Pool. +**Note** + +In a push model, event sources (such as Amazon S3 and custom applications need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function. + +For more information on using the Lambda API to add permission, see AddPermission : https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html. + +For adding permission using the AWS CLI, see add-permission : https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html .PARAMETER CreateAuthChallenge + Creates an authentication challenge. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge PrimitiveType: String UpdateType: Mutable .PARAMETER PreAuthentication + A pre-authentication AWS Lambda trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication PrimitiveType: String UpdateType: Mutable .PARAMETER DefineAuthChallenge + Defines the authentication challenge. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge PrimitiveType: String UpdateType: Mutable .PARAMETER PreSignUp + A pre-registration AWS Lambda trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup PrimitiveType: String UpdateType: Mutable .PARAMETER PreTokenGeneration + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration PrimitiveType: String UpdateType: Mutable .PARAMETER UserMigration + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration PrimitiveType: String UpdateType: Mutable .PARAMETER PostAuthentication + A post-authentication AWS Lambda trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication PrimitiveType: String UpdateType: Mutable .PARAMETER PostConfirmation + A post-confirmation AWS Lambda trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation PrimitiveType: String UpdateType: Mutable .PARAMETER CustomMessage + A custom Message AWS Lambda trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage PrimitiveType: String UpdateType: Mutable .PARAMETER VerifyAuthChallengeResponse + Verifies the authentication challenge response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 index f99c22397..a7bcfc384 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolNumberAttributeConstraints { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.NumberAttributeConstraints resource property to the template. + Adds an AWS::Cognito::UserPool.NumberAttributeConstraints resource property to the template. The NumberAttributeConstraints property type defines the number attribute constraints of an Amazon Cognito User Pool. NumberAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. .DESCRIPTION Adds an AWS::Cognito::UserPool.NumberAttributeConstraints resource property to the template. - +The NumberAttributeConstraints property type defines the number attribute constraints of an Amazon Cognito User Pool. NumberAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html .PARAMETER MinValue + The minimum value of an attribute that is of the number data type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-minvalue PrimitiveType: String UpdateType: Mutable .PARAMETER MaxValue + The maximum value of an attribute that is of the number data type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-maxvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 index efaa225bb..6c6cdfff9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 @@ -1,41 +1,54 @@ function Add-VSCognitoUserPoolPasswordPolicy { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.PasswordPolicy resource property to the template. + Adds an AWS::Cognito::UserPool.PasswordPolicy resource property to the template. PasswordPolicy is a subproperty of the Policies: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html property that defines the password policy of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.PasswordPolicy resource property to the template. - +PasswordPolicy is a subproperty of the Policies: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html property that defines the password policy of an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html .PARAMETER RequireNumbers + In the password policy that you have set, refers to whether you have required users to use at least one number in their password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MinimumLength + The minimum length of the password policy that you have set. Cannot be less than 6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-minimumlength PrimitiveType: Integer UpdateType: Mutable .PARAMETER TemporaryPasswordValidityDays + In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator. +When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the deprecated UnusedAccountValidityDays value for that user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-temporarypasswordvaliditydays PrimitiveType: Integer UpdateType: Mutable .PARAMETER RequireUppercase + In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RequireLowercase + In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RequireSymbols + In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 index 41cb20f1f..0dd9873b0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoUserPoolPolicies { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.Policies resource property to the template. + Adds an AWS::Cognito::UserPool.Policies resource property to the template. Policies is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the password policies of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.Policies resource property to the template. - +Policies is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the password policies of an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html .PARAMETER PasswordPolicy + The password policy. + Type: PasswordPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-passwordpolicy UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 index 01c3fc160..fdd0f1e10 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 @@ -1,46 +1,61 @@ function Add-VSCognitoUserPoolSchemaAttribute { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.SchemaAttribute resource property to the template. + Adds an AWS::Cognito::UserPool.SchemaAttribute resource property to the template. SchemaAttribute is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the schema attributes of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.SchemaAttribute resource property to the template. - +SchemaAttribute is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the schema attributes of an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html .PARAMETER DeveloperOnlyAttribute + Specifies whether the attribute type is developer only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Mutable + Specifies whether the value of the attribute can be changed. +For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AttributeDataType + The attribute data type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype PrimitiveType: String UpdateType: Mutable .PARAMETER StringAttributeConstraints + Specifies the constraints for an attribute of the string type. + Type: StringAttributeConstraints Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints UpdateType: Mutable .PARAMETER Required + Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required PrimitiveType: Boolean UpdateType: Mutable .PARAMETER NumberAttributeConstraints + Specifies the constraints for an attribute of the number type. + Type: NumberAttributeConstraints Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints UpdateType: Mutable .PARAMETER Name + A schema attribute of the name type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 index da38e21b3..8e69c7b08 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 @@ -1,21 +1,26 @@ function Add-VSCognitoUserPoolSmsConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.SmsConfiguration resource property to the template. + Adds an AWS::Cognito::UserPool.SmsConfiguration resource property to the template. SmsConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the SMS configuration of an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.SmsConfiguration resource property to the template. - +SmsConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the SMS configuration of an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html .PARAMETER ExternalId + The external ID used in IAM role trust relationships. +For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html in the *AWS Identity and Access Management User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-externalid PrimitiveType: String UpdateType: Mutable .PARAMETER SnsCallerArn + The Amazon Resource Name ARN of the Amazon Simple Notification Service SNS caller. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snscallerarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 index db6db0f57..762630132 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolStringAttributeConstraints { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.StringAttributeConstraints resource property to the template. + Adds an AWS::Cognito::UserPool.StringAttributeConstraints resource property to the template. The StringAttributeConstraints property type defines the string attribute constraints of an Amazon Cognito User Pool. StringAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. .DESCRIPTION Adds an AWS::Cognito::UserPool.StringAttributeConstraints resource property to the template. - +The StringAttributeConstraints property type defines the string attribute constraints of an Amazon Cognito User Pool. StringAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html .PARAMETER MinLength + The minimum length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength PrimitiveType: String UpdateType: Mutable .PARAMETER MaxLength + The maximum length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-maxlength PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 index 67dc76954..6089992da 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolUserAttributeType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolUser.AttributeType resource property to the template. + Adds an AWS::Cognito::UserPoolUser.AttributeType resource property to the template. AttributeType is a property of the AWS::Cognito::UserPoolUser: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html resource that defines name-value pairs for a user in an Amazon Cognito User Pool. .DESCRIPTION Adds an AWS::Cognito::UserPoolUser.AttributeType resource property to the template. - +AttributeType is a property of the AWS::Cognito::UserPoolUser: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html resource that defines name-value pairs for a user in an Amazon Cognito User Pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html .PARAMETER Value + The value of the attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 index 24e0668e1..ab99fed37 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoUserPoolUserPoolAddOns { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.UserPoolAddOns resource property to the template. + Adds an AWS::Cognito::UserPool.UserPoolAddOns resource property to the template. UserPoolAddOns is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that enables advanced security risk detection. .DESCRIPTION Adds an AWS::Cognito::UserPool.UserPoolAddOns resource property to the template. - +UserPoolAddOns is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that enables advanced security risk detection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html .PARAMETER AdvancedSecurityMode + The advanced security mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecuritymode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 index 9d768a4c9..dcba5b167 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 @@ -1,41 +1,53 @@ function Add-VSCognitoUserPoolVerificationMessageTemplate { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.VerificationMessageTemplate resource property to the template. + Adds an AWS::Cognito::UserPool.VerificationMessageTemplate resource property to the template. VerificationMessageTemplate is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the template for verification messages. .DESCRIPTION Adds an AWS::Cognito::UserPool.VerificationMessageTemplate resource property to the template. - +VerificationMessageTemplate is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the template for verification messages. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html .PARAMETER EmailMessageByLink + The email message template for sending a confirmation link to the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailmessagebylink PrimitiveType: String UpdateType: Mutable .PARAMETER EmailMessage + The email message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailmessage PrimitiveType: String UpdateType: Mutable .PARAMETER SmsMessage + The SMS message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-smsmessage PrimitiveType: String UpdateType: Mutable .PARAMETER EmailSubject + The subject line for the email message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailsubject PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultEmailOption + The default email option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-defaultemailoption PrimitiveType: String UpdateType: Mutable .PARAMETER EmailSubjectByLink + The subject line for the email message template for sending a confirmation link to the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailsubjectbylink PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleScope.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleScope.ps1 index 24de77098..7b6cf4502 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleScope.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleScope.ps1 @@ -1,21 +1,25 @@ function Add-VSConfigConfigRuleScope { <# .SYNOPSIS - Adds an AWS::Config::ConfigRule.Scope resource property to the template. + Adds an AWS::Config::ConfigRule.Scope resource property to the template. Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration. .DESCRIPTION Adds an AWS::Config::ConfigRule.Scope resource property to the template. - +Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html .PARAMETER ComplianceResourceId + The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourceid PrimitiveType: String UpdateType: Mutable .PARAMETER ComplianceResourceTypes + The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourcetypes DuplicatesAllowed: False PrimitiveItemType: String @@ -23,11 +27,15 @@ function Add-VSConfigConfigRuleScope { UpdateType: Mutable .PARAMETER TagKey + The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagkey PrimitiveType: String UpdateType: Mutable .PARAMETER TagValue + The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSource.ps1 index e166938f2..b3ae6a8cf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSource.ps1 @@ -1,21 +1,25 @@ function Add-VSConfigConfigRuleSource { <# .SYNOPSIS - Adds an AWS::Config::ConfigRule.Source resource property to the template. + Adds an AWS::Config::ConfigRule.Source resource property to the template. Provides the AWS Config rule owner (AWS or customer, the rule identifier, and the events that trigger the evaluation of your AWS resources. .DESCRIPTION Adds an AWS::Config::ConfigRule.Source resource property to the template. - +Provides the AWS Config rule owner (AWS or customer, the rule identifier, and the events that trigger the evaluation of your AWS resources. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html .PARAMETER Owner + Indicates whether AWS or the customer owns and manages the AWS Config rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-owner PrimitiveType: String UpdateType: Mutable .PARAMETER SourceDetails + Provides the source and type of the event that causes AWS Config to evaluate your AWS resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-sourcedetails DuplicatesAllowed: False ItemType: SourceDetail @@ -23,6 +27,9 @@ function Add-VSConfigConfigRuleSource { UpdateType: Mutable .PARAMETER SourceIdentifier + For AWS Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html. +For custom rules, the identifier is the Amazon Resource Name ARN of the rule's AWS Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-sourceidentifier PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSourceDetail.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSourceDetail.ps1 index 4a5a2a5fe..d954ea9aa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSourceDetail.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigRuleSourceDetail.ps1 @@ -1,26 +1,39 @@ function Add-VSConfigConfigRuleSourceDetail { <# .SYNOPSIS - Adds an AWS::Config::ConfigRule.SourceDetail resource property to the template. + Adds an AWS::Config::ConfigRule.SourceDetail resource property to the template. Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules. .DESCRIPTION Adds an AWS::Config::ConfigRule.SourceDetail resource property to the template. - +Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html .PARAMETER EventSource + The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html#cfn-config-configrule-source-sourcedetail-eventsource PrimitiveType: String UpdateType: Mutable .PARAMETER MaximumExecutionFrequency + The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value. +By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. +Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html#cfn-config-configrule-sourcedetail-maximumexecutionfrequency PrimitiveType: String UpdateType: Mutable .PARAMETER MessageType + The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types: ++ ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change. ++ OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. ++ ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency. ++ ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot. +If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html#cfn-config-configrule-source-sourcedetail-messagetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorAccountAggregationSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorAccountAggregationSource.ps1 index b2ac33f56..371a9d434 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorAccountAggregationSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorAccountAggregationSource.ps1 @@ -1,27 +1,33 @@ function Add-VSConfigConfigurationAggregatorAccountAggregationSource { <# .SYNOPSIS - Adds an AWS::Config::ConfigurationAggregator.AccountAggregationSource resource property to the template. + Adds an AWS::Config::ConfigurationAggregator.AccountAggregationSource resource property to the template. A collection of accounts and regions. .DESCRIPTION Adds an AWS::Config::ConfigurationAggregator.AccountAggregationSource resource property to the template. - +A collection of accounts and regions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html .PARAMETER AllAwsRegions + If true, aggregate existing AWS Config regions and future regions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-allawsregions PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AwsRegions + The source regions being aggregated. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-awsregions UpdateType: Mutable .PARAMETER AccountIds + The 12-digit account ID of the account being aggregated. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-accountids diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorOrganizationAggregationSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorOrganizationAggregationSource.ps1 index afbe60b0f..d4717f8c4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorOrganizationAggregationSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationAggregatorOrganizationAggregationSource.ps1 @@ -1,27 +1,33 @@ function Add-VSConfigConfigurationAggregatorOrganizationAggregationSource { <# .SYNOPSIS - Adds an AWS::Config::ConfigurationAggregator.OrganizationAggregationSource resource property to the template. + Adds an AWS::Config::ConfigurationAggregator.OrganizationAggregationSource resource property to the template. This object contains regions to set up the aggregator and an IAM role to retrieve organization details. .DESCRIPTION Adds an AWS::Config::ConfigurationAggregator.OrganizationAggregationSource resource property to the template. - +This object contains regions to set up the aggregator and an IAM role to retrieve organization details. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html .PARAMETER AllAwsRegions + If true, aggregate existing AWS Config regions and future regions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-allawsregions PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AwsRegions + The source regions being aggregated. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-awsregions UpdateType: Mutable .PARAMETER RoleArn + ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationRecorderRecordingGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationRecorderRecordingGroup.ps1 index 7a2219688..91e95015c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationRecorderRecordingGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConfigurationRecorderRecordingGroup.ps1 @@ -1,26 +1,56 @@ function Add-VSConfigConfigurationRecorderRecordingGroup { <# .SYNOPSIS - Adds an AWS::Config::ConfigurationRecorder.RecordingGroup resource property to the template. + Adds an AWS::Config::ConfigurationRecorder.RecordingGroup resource property to the template. Specifies the types of AWS resource for which AWS Config records configuration changes. .DESCRIPTION Adds an AWS::Config::ConfigurationRecorder.RecordingGroup resource property to the template. +Specifies the types of AWS resource for which AWS Config records configuration changes. +In the recording group, you specify whether all supported types or specific types of resources are recorded. + +By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes. + +You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources. Global resources are not tied to an individual region and can be used in all regions. + +**Important** + +The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions. + +If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter. + +For a list of supported resource types, see Supported Resource Types: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources. + +For more information, see Selecting Which Resources AWS Config Records: https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html .PARAMETER AllSupported + Specifies whether AWS Config records configuration changes for every supported type of regional resource. +If you set this option to true, when AWS Config adds support for a new type of regional resource, it starts recording resources of that type automatically. +If you set this option to true, you cannot enumerate a list of resourceTypes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-allsupported PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeGlobalResourceTypes + Specifies whether AWS Config includes all supported types of global resources for example, IAM resources with the resources that it records. +Before you can set this option to true, you must set the allSupported option to true. +If you set this option to true, when AWS Config adds support for a new type of global resource, it starts recording resources of that type automatically. +The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-includeglobalresourcetypes PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ResourceTypes + A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes for example, AWS::EC2::Instance or AWS::CloudTrail::Trail. +Before you can set this option to true, you must set the allSupported option to false. +If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group. +For a list of valid resourceTypes values, see the **resourceType Value** column in Supported AWS Resource Types: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-resourcetypes DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigDeliveryChannelConfigSnapshotDeliveryProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigDeliveryChannelConfigSnapshotDeliveryProperties.ps1 index 8820a4d36..e827548fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigDeliveryChannelConfigSnapshotDeliveryProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigDeliveryChannelConfigSnapshotDeliveryProperties.ps1 @@ -1,16 +1,42 @@ function Add-VSConfigDeliveryChannelConfigSnapshotDeliveryProperties { <# .SYNOPSIS - Adds an AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties resource property to the template. + Adds an AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties resource property to the template. Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel. .DESCRIPTION Adds an AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties resource property to the template. +Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel. +**Note** + +If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following: + +The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent: + ++ The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for AWS Config rules. + ++ The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule: https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigRule.html. + +If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value. + +1. For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot. + +1. You specify the MaximumExecutionFrequency value for Six_Hours. + +1. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours. + +1. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, AWS Config invokes evaluations for the rule every 24 hours. + +You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action. + +To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html .PARAMETER DeliveryFrequency + The frequency with which AWS Config delivers configuration snapshots. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties-deliveryfrequency PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationCustomRuleMetadata.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationCustomRuleMetadata.ps1 index 8710be902..f0177de40 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationCustomRuleMetadata.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationCustomRuleMetadata.ps1 @@ -1,58 +1,80 @@ function Add-VSConfigOrganizationConfigRuleOrganizationCustomRuleMetadata { <# .SYNOPSIS - Adds an AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata resource property to the template. + Adds an AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata resource property to the template. An object that specifies organization custom rule metadata such as resource type, resource ID of AWS resource, Lamdba function ARN, and organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. .DESCRIPTION Adds an AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata resource property to the template. - +An object that specifies organization custom rule metadata such as resource type, resource ID of AWS resource, Lamdba function ARN, and organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html .PARAMETER TagKeyScope + One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-tagkeyscope PrimitiveType: String UpdateType: Mutable .PARAMETER TagValueScope + The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-tagvaluescope PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description that you provide for organization config rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-description PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceIdScope + The ID of the AWS resource that was evaluated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-resourceidscope PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaFunctionArn + The lambda function ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-lambdafunctionarn PrimitiveType: String UpdateType: Mutable .PARAMETER OrganizationConfigRuleTriggerTypes + The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types: ++ ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change. ++ OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. ++ ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-organizationconfigruletriggertypes UpdateType: Mutable .PARAMETER ResourceTypesScope + The type of the AWS resource that was evaluated. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-resourcetypesscope UpdateType: Mutable .PARAMETER MaximumExecutionFrequency + The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties. +By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-maximumexecutionfrequency PrimitiveType: String UpdateType: Mutable .PARAMETER InputParameters + A string, in JSON format, that is passed to organization config rule Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-inputparameters PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationManagedRuleMetadata.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationManagedRuleMetadata.ps1 index da17b5216..555528484 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationManagedRuleMetadata.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConfigRuleOrganizationManagedRuleMetadata.ps1 @@ -1,52 +1,69 @@ function Add-VSConfigOrganizationConfigRuleOrganizationManagedRuleMetadata { <# .SYNOPSIS - Adds an AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata resource property to the template. + Adds an AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata resource property to the template. An object that specifies organization managed rule metadata such as resource type and ID of AWS resource along with the rule identifier. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. .DESCRIPTION Adds an AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata resource property to the template. - +An object that specifies organization managed rule metadata such as resource type and ID of AWS resource along with the rule identifier. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html .PARAMETER TagKeyScope + One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagkeyscope PrimitiveType: String UpdateType: Mutable .PARAMETER TagValueScope + The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagvaluescope PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description that you provide for organization config rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-description PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceIdScope + The ID of the AWS resource that was evaluated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourceidscope PrimitiveType: String UpdateType: Mutable .PARAMETER RuleIdentifier + For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-ruleidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceTypesScope + The type of the AWS resource that was evaluated. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourcetypesscope UpdateType: Mutable .PARAMETER MaximumExecutionFrequency + The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that is triggered at a periodic frequency. +By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-maximumexecutionfrequency PrimitiveType: String UpdateType: Mutable .PARAMETER InputParameters + A string, in JSON format, that is passed to organization config rule Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-inputparameters PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationRemediationParameterValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationRemediationParameterValue.ps1 index 216ce9a01..85f31ac94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationRemediationParameterValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationRemediationParameterValue.ps1 @@ -1,21 +1,25 @@ function Add-VSConfigRemediationConfigurationRemediationParameterValue { <# .SYNOPSIS - Adds an AWS::Config::RemediationConfiguration.RemediationParameterValue resource property to the template. + Adds an AWS::Config::RemediationConfiguration.RemediationParameterValue resource property to the template. The value is either a dynamic (resource value or a static value. You must select either a dynamic value or a static value. .DESCRIPTION Adds an AWS::Config::RemediationConfiguration.RemediationParameterValue resource property to the template. - +The value is either a dynamic (resource value or a static value. You must select either a dynamic value or a static value. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html .PARAMETER ResourceValue + The value is dynamic and changes at run-time. + Type: ResourceValue Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html#cfn-config-remediationconfiguration-remediationparametervalue-resourcevalue UpdateType: Mutable .PARAMETER StaticValue + The value is static and does not change at run-time. + Type: StaticValue Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html#cfn-config-remediationconfiguration-remediationparametervalue-staticvalue UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationResourceValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationResourceValue.ps1 index bc95d438b..a4ef6aac0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationResourceValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationResourceValue.ps1 @@ -1,16 +1,18 @@ function Add-VSConfigRemediationConfigurationResourceValue { <# .SYNOPSIS - Adds an AWS::Config::RemediationConfiguration.ResourceValue resource property to the template. + Adds an AWS::Config::RemediationConfiguration.ResourceValue resource property to the template. The dynamic value of the resource. .DESCRIPTION Adds an AWS::Config::RemediationConfiguration.ResourceValue resource property to the template. - +The dynamic value of the resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-resourcevalue.html .PARAMETER Value + The value is a resource ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-resourcevalue.html#cfn-config-remediationconfiguration-resourcevalue-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationStaticValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationStaticValue.ps1 index 37688f2d6..3d88e109e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationStaticValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationStaticValue.ps1 @@ -1,16 +1,18 @@ function Add-VSConfigRemediationConfigurationStaticValue { <# .SYNOPSIS - Adds an AWS::Config::RemediationConfiguration.StaticValue resource property to the template. + Adds an AWS::Config::RemediationConfiguration.StaticValue resource property to the template. The static value of the resource. .DESCRIPTION Adds an AWS::Config::RemediationConfiguration.StaticValue resource property to the template. - +The static value of the resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-staticvalue.html .PARAMETER Values + A list of values. For example, the ARN of the assumed role. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-staticvalue.html#cfn-config-remediationconfiguration-staticvalue-values diff --git a/VaporShell/Public/Resource Property Types/Add-VSDAXClusterSSESpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDAXClusterSSESpecification.ps1 index 6305f510c..6b045f386 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDAXClusterSSESpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDAXClusterSSESpecification.ps1 @@ -1,16 +1,18 @@ function Add-VSDAXClusterSSESpecification { <# .SYNOPSIS - Adds an AWS::DAX::Cluster.SSESpecification resource property to the template. + Adds an AWS::DAX::Cluster.SSESpecification resource property to the template. Represents the settings used to enable server-side encryption. .DESCRIPTION Adds an AWS::DAX::Cluster.SSESpecification resource property to the template. - +Represents the settings used to enable server-side encryption. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dax-cluster-ssespecification.html .PARAMETER SSEEnabled + Indicates whether server-side encryption is enabled true or disabled false on the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dax-cluster-ssespecification.html#cfn-dax-cluster-ssespecification-sseenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCreateRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCreateRule.ps1 index 1cf720f32..5f91801f3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCreateRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCreateRule.ps1 @@ -1,27 +1,34 @@ function Add-VSDLMLifecyclePolicyCreateRule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.CreateRule resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.CreateRule resource property to the template. Specifies when to create snapshots of EBS volumes. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CreateRule resource property to the template. - +Specifies when to create snapshots of EBS volumes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html .PARAMETER IntervalUnit + The interval unit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Times + The time, in UTC, to start the operation. The supported format is hh:mm. +The operation occurs within a one-hour window following the specified time. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-times UpdateType: Mutable .PARAMETER Interval + The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-interval PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 index 534bbb785..26eb18b0f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 @@ -1,38 +1,48 @@ function Add-VSDLMLifecyclePolicyPolicyDetails { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.PolicyDetails resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.PolicyDetails resource property to the template. Specifies the configuration of a lifecycle policy. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.PolicyDetails resource property to the template. - +Specifies the configuration of a lifecycle policy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html .PARAMETER ResourceTypes + The resource type. Specify one of INSTANCE or VOLUME. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcetypes UpdateType: Mutable .PARAMETER Schedules + The schedule of policy-defined actions. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-schedules ItemType: Schedule UpdateType: Mutable .PARAMETER PolicyType + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policytype PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: Parameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-parameters UpdateType: Mutable .PARAMETER TargetTags + The single tag that identifies targeted resources for this policy. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-targettags ItemType: Tag diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 index c973cc20d..55940f4fc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 @@ -1,26 +1,32 @@ function Add-VSDLMLifecyclePolicyRetainRule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. Specifies the number of snapshots to keep for each EBS volume. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. - +Specifies the number of snapshots to keep for each EBS volume. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html .PARAMETER IntervalUnit + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Count + The number of snapshots to keep for each volume, up to a maximum of 1000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Interval + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-interval PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 index e065670fa..1c134ddd9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 @@ -1,54 +1,70 @@ function Add-VSDLMLifecyclePolicySchedule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.Schedule resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.Schedule resource property to the template. Specifies a backup schedule. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.Schedule resource property to the template. - +Specifies a backup schedule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html .PARAMETER TagsToAdd + The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-tagstoadd ItemType: Tag UpdateType: Mutable .PARAMETER CreateRule + The create rule. + Type: CreateRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-createrule UpdateType: Mutable .PARAMETER VariableTags + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-variabletags ItemType: Tag UpdateType: Mutable .PARAMETER FastRestoreRule + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: FastRestoreRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-fastrestorerule UpdateType: Mutable .PARAMETER RetainRule + The retain rule. + Type: RetainRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-retainrule UpdateType: Mutable .PARAMETER CrossRegionCopyRules + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-crossregioncopyrules ItemType: CrossRegionCopyRule UpdateType: Mutable .PARAMETER Name + The name of the schedule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-name PrimitiveType: String UpdateType: Mutable .PARAMETER CopyTags + Copy all user-defined tags on a source volume to snapshots of the volume created by this policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-copytags PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointDynamoDbSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointDynamoDbSettings.ps1 index 850c0804e..141e146f7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointDynamoDbSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointDynamoDbSettings.ps1 @@ -1,16 +1,52 @@ function Add-VSDMSEndpointDynamoDbSettings { <# .SYNOPSIS - Adds an AWS::DMS::Endpoint.DynamoDbSettings resource property to the template. + Adds an AWS::DMS::Endpoint.DynamoDbSettings resource property to the template. ## Syntax .DESCRIPTION Adds an AWS::DMS::Endpoint.DynamoDbSettings resource property to the template. +## Syntax +To declare this entity in your AWS CloudFormation template, use the following syntax: + +### JSON + + + +{ + +"ServiceAccessRoleArn: #cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn" : String + +} + + + +### YAML + + + +ServiceAccessRoleArn: #cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn: String + + + +## Properties + +ServiceAccessRoleArn + +The Amazon Resource Name (ARN used by the service access IAM role. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html .PARAMETER ServiceAccessRoleArn + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html#cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 index 9698c0599..1cd7a5ed1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 @@ -1,31 +1,115 @@ function Add-VSDMSEndpointElasticsearchSettings { <# .SYNOPSIS - Adds an AWS::DMS::Endpoint.ElasticsearchSettings resource property to the template. + Adds an AWS::DMS::Endpoint.ElasticsearchSettings resource property to the template. ## Syntax .DESCRIPTION Adds an AWS::DMS::Endpoint.ElasticsearchSettings resource property to the template. +## Syntax +To declare this entity in your AWS CloudFormation template, use the following syntax: + +### JSON + + + +{ + +"EndpointUri: #cfn-dms-endpoint-elasticsearchsettings-endpointuri" : String, + +"ErrorRetryDuration: #cfn-dms-endpoint-elasticsearchsettings-errorretryduration" : Integer, + +"FullLoadErrorPercentage: #cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage" : Integer, + +"ServiceAccessRoleArn: #cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn" : String + +} + + + +### YAML + + + +EndpointUri: #cfn-dms-endpoint-elasticsearchsettings-endpointuri: String + +ErrorRetryDuration: #cfn-dms-endpoint-elasticsearchsettings-errorretryduration: Integer + +FullLoadErrorPercentage: #cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage: Integer + +ServiceAccessRoleArn: #cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn: String + + + +## Properties + +EndpointUri + +The endpoint for the ElasticSearch cluster. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +ErrorRetryDuration + +The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster. + +*Required*: No + +*Type*: Integer + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +FullLoadErrorPercentage + +The maximum percentage of records that can fail to be written before a full load operation stops. + +*Required*: No + +*Type*: Integer + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +ServiceAccessRoleArn + +The Amazon Resource Name (ARN used by service to access the IAM role. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html .PARAMETER EndpointUri + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-endpointuri PrimitiveType: String UpdateType: Mutable .PARAMETER FullLoadErrorPercentage + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage PrimitiveType: Integer UpdateType: Mutable .PARAMETER ErrorRetryDuration + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-errorretryduration PrimitiveType: Integer UpdateType: Mutable .PARAMETER ServiceAccessRoleArn + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointKinesisSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointKinesisSettings.ps1 index 36f259073..76b09a4ef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointKinesisSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointKinesisSettings.ps1 @@ -1,26 +1,96 @@ function Add-VSDMSEndpointKinesisSettings { <# .SYNOPSIS - Adds an AWS::DMS::Endpoint.KinesisSettings resource property to the template. + Adds an AWS::DMS::Endpoint.KinesisSettings resource property to the template. ## Syntax .DESCRIPTION Adds an AWS::DMS::Endpoint.KinesisSettings resource property to the template. +## Syntax +To declare this entity in your AWS CloudFormation template, use the following syntax: + +### JSON + + + +{ + +"MessageFormat: #cfn-dms-endpoint-kinesissettings-messageformat" : String, + +"ServiceAccessRoleArn: #cfn-dms-endpoint-kinesissettings-serviceaccessrolearn" : String, + +"StreamArn: #cfn-dms-endpoint-kinesissettings-streamarn" : String + +} + + + +### YAML + + + +MessageFormat: #cfn-dms-endpoint-kinesissettings-messageformat: String + +ServiceAccessRoleArn: #cfn-dms-endpoint-kinesissettings-serviceaccessrolearn: String + +StreamArn: #cfn-dms-endpoint-kinesissettings-streamarn: String + + + +## Properties + +MessageFormat + +The output format for the records created on the endpoint. The message format is JSON. + +*Required*: No + +*Type*: String + +*Allowed Values*: json + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +ServiceAccessRoleArn + +The Amazon Resource Name (ARN for the IAM role that DMS uses to write to the Amazon Kinesis data stream. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +StreamArn + +The Amazon Resource Name (ARN for the Amazon Kinesis Data Streams endpoint. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html .PARAMETER MessageFormat + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-messageformat PrimitiveType: String UpdateType: Mutable .PARAMETER StreamArn + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-streamarn PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceAccessRoleArn + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-serviceaccessrolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 index 56d965ee7..27a84b658 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 @@ -1,66 +1,286 @@ function Add-VSDMSEndpointMongoDbSettings { <# .SYNOPSIS - Adds an AWS::DMS::Endpoint.MongoDbSettings resource property to the template. + Adds an AWS::DMS::Endpoint.MongoDbSettings resource property to the template. ## Syntax .DESCRIPTION Adds an AWS::DMS::Endpoint.MongoDbSettings resource property to the template. +## Syntax +To declare this entity in your AWS CloudFormation template, use the following syntax: + +### JSON + + + +{ + +"AuthMechanism: #cfn-dms-endpoint-mongodbsettings-authmechanism" : String, + +"AuthSource: #cfn-dms-endpoint-mongodbsettings-authsource" : String, + +"AuthType: #cfn-dms-endpoint-mongodbsettings-authtype" : String, + +"DatabaseName: #cfn-dms-endpoint-mongodbsettings-databasename" : String, + +"DocsToInvestigate: #cfn-dms-endpoint-mongodbsettings-docstoinvestigate" : String, + +"ExtractDocId: #cfn-dms-endpoint-mongodbsettings-extractdocid" : String, + +"NestingLevel: #cfn-dms-endpoint-mongodbsettings-nestinglevel" : String, + +"Password: #cfn-dms-endpoint-mongodbsettings-password" : String, + +"Port: #cfn-dms-endpoint-mongodbsettings-port" : Integer, + +"ServerName: #cfn-dms-endpoint-mongodbsettings-servername" : String, + +"Username: #cfn-dms-endpoint-mongodbsettings-username" : String + +} + + + +### YAML + + + +AuthMechanism: #cfn-dms-endpoint-mongodbsettings-authmechanism: String + +AuthSource: #cfn-dms-endpoint-mongodbsettings-authsource: String + +AuthType: #cfn-dms-endpoint-mongodbsettings-authtype: String + +DatabaseName: #cfn-dms-endpoint-mongodbsettings-databasename: String + +DocsToInvestigate: #cfn-dms-endpoint-mongodbsettings-docstoinvestigate: String + +ExtractDocId: #cfn-dms-endpoint-mongodbsettings-extractdocid: String + +NestingLevel: #cfn-dms-endpoint-mongodbsettings-nestinglevel: String + +Password: #cfn-dms-endpoint-mongodbsettings-password: String + +Port: #cfn-dms-endpoint-mongodbsettings-port: Integer + +ServerName: #cfn-dms-endpoint-mongodbsettings-servername: String + +Username: #cfn-dms-endpoint-mongodbsettings-username: String + + + +## Properties + +AuthMechanism + +The authentication mechanism you use to access the MongoDB source endpoint. + +Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 + +DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No. + +*Required*: No + +*Type*: String + +*Allowed Values*: default | mongodb_cr | scram_sha_1 + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +AuthSource + +The MongoDB database name. This attribute is not used when authType=NO. + +The default is admin. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +AuthType + +The authentication type you use to access the MongoDB source endpoint. + +Valid values: NO, PASSWORD + +When NO is selected, user name and password parameters are not used and can be empty. + +*Required*: No + +*Type*: String + +*Allowed Values*: no | password + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +DatabaseName + +The database name on the MongoDB source endpoint. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +DocsToInvestigate + +Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE. + +Must be a positive value greater than 0. Default value is 1000. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +ExtractDocId + +Specifies the document ID. Use this attribute when NestingLevel is set to NONE. + +Default value is false. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +NestingLevel + +Specifies either document or table mode. + +Valid values: NONE, ONE + +Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode. + +*Required*: No + +*Type*: String + +*Allowed Values*: none | one + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +Password + +The password for the user account you use to access the MongoDB source endpoint. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +Port + +The port value for the MongoDB source endpoint. + +*Required*: No + +*Type*: Integer + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +ServerName + +The name of the server on the MongoDB source endpoint. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + +Username + +The user name you use to access the MongoDB source endpoint. + +*Required*: No + +*Type*: String + +*Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html .PARAMETER AuthSource + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authsource PrimitiveType: String UpdateType: Mutable .PARAMETER AuthMechanism + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authmechanism PrimitiveType: String UpdateType: Mutable .PARAMETER Username + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-username PrimitiveType: String UpdateType: Mutable .PARAMETER DocsToInvestigate + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-docstoinvestigate PrimitiveType: String UpdateType: Mutable .PARAMETER ServerName + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername PrimitiveType: String UpdateType: Mutable .PARAMETER Port + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER ExtractDocId + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-extractdocid PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER AuthType + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authtype PrimitiveType: String UpdateType: Mutable .PARAMETER Password + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-password PrimitiveType: String UpdateType: Mutable .PARAMETER NestingLevel + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-nestinglevel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 index 1de072a00..f5fd6e740 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 @@ -1,46 +1,60 @@ function Add-VSDMSEndpointS3Settings { <# .SYNOPSIS - Adds an AWS::DMS::Endpoint.S3Settings resource property to the template. + Adds an AWS::DMS::Endpoint.S3Settings resource property to the template. Settings for exporting data to Amazon S3. .DESCRIPTION Adds an AWS::DMS::Endpoint.S3Settings resource property to the template. - +Settings for exporting data to Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html .PARAMETER ExternalTableDefinition + The external table definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-externaltabledefinition PrimitiveType: String UpdateType: Mutable .PARAMETER BucketName + The name of the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER BucketFolder + An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path ///. If this parameter is not specified, then the path used is //. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketfolder PrimitiveType: String UpdateType: Mutable .PARAMETER CsvRowDelimiter + The delimiter used to separate rows in the source files. The default is a carriage return n. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER CsvDelimiter + The delimiter used to separate columns in the source files. The default is a comma. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceAccessRoleArn + The Amazon Resource Name ARN used by the service access IAM role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-serviceaccessrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER CompressionType + An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE the default or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-compressiontype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineField.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineField.ps1 index f60626f5c..3ff746eea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineField.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineField.ps1 @@ -1,26 +1,36 @@ function Add-VSDataPipelinePipelineField { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline.Field resource property to the template. + Adds an AWS::DataPipeline::Pipeline.Field resource property to the template. A key-value pair that describes a property of a PipelineObject. The value is specified as either a string value (StringValue or a reference to another object (RefValue but not as both. To view fields for a data pipeline object, see Pipeline Object Reference: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html in the *AWS Data Pipeline Developer Guide*. .DESCRIPTION Adds an AWS::DataPipeline::Pipeline.Field resource property to the template. - +A key-value pair that describes a property of a PipelineObject. The value is specified as either a string value (StringValue or a reference to another object (RefValue but not as both. To view fields for a data pipeline object, see Pipeline Object Reference: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html in the *AWS Data Pipeline Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html .PARAMETER Key + Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html in the *AWS Data Pipeline Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-key PrimitiveType: String UpdateType: Mutable .PARAMETER RefValue + A field value that you specify as an identifier of another object in the same pipeline definition. +You can specify the field value as either a string value StringValue or a reference to another object RefValue, but not both. +Required if the key that you are using requires it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-refvalue PrimitiveType: String UpdateType: Mutable .PARAMETER StringValue + A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html in the *AWS Data Pipeline Developer Guide*. +You can specify the field value as either a string value StringValue or a reference to another object RefValue, but not both. +Required if the key that you are using requires it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-stringvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterAttribute.ps1 index 11b2eba0d..22c80021b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterAttribute.ps1 @@ -1,21 +1,25 @@ function Add-VSDataPipelinePipelineParameterAttribute { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline.ParameterAttribute resource property to the template. + Adds an AWS::DataPipeline::Pipeline.ParameterAttribute resource property to the template. Attribute is a property of ParameterObject that defines the attributes of a parameter object as key-value pairs. .DESCRIPTION Adds an AWS::DataPipeline::Pipeline.ParameterAttribute resource property to the template. - +Attribute is a property of ParameterObject that defines the attributes of a parameter object as key-value pairs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html .PARAMETER Key + The field identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html#cfn-datapipeline-pipeline-parameterobjects-attribtues-key PrimitiveType: String UpdateType: Mutable .PARAMETER StringValue + The field value, expressed as a String. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html#cfn-datapipeline-pipeline-parameterobjects-attribtues-stringvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterObject.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterObject.ps1 index 1cbf7be55..857edc1ec 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterObject.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterObject.ps1 @@ -1,16 +1,18 @@ function Add-VSDataPipelinePipelineParameterObject { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline.ParameterObject resource property to the template. + Adds an AWS::DataPipeline::Pipeline.ParameterObject resource property to the template. Contains information about a parameter object. .DESCRIPTION Adds an AWS::DataPipeline::Pipeline.ParameterObject resource property to the template. - +Contains information about a parameter object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html .PARAMETER Attributes + The attributes of the parameter object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html#cfn-datapipeline-pipeline-parameterobjects-attributes DuplicatesAllowed: True ItemType: ParameterAttribute @@ -18,6 +20,8 @@ function Add-VSDataPipelinePipelineParameterObject { UpdateType: Mutable .PARAMETER Id + The ID of the parameter object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html#cfn-datapipeline-pipeline-parameterobjects-id PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterValue.ps1 index 083e60717..d0c4198d3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelineParameterValue.ps1 @@ -1,21 +1,25 @@ function Add-VSDataPipelinePipelineParameterValue { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline.ParameterValue resource property to the template. + Adds an AWS::DataPipeline::Pipeline.ParameterValue resource property to the template. A value or list of parameter values. .DESCRIPTION Adds an AWS::DataPipeline::Pipeline.ParameterValue resource property to the template. - +A value or list of parameter values. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html .PARAMETER Id + The ID of the parameter value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html#cfn-datapipeline-pipeline-parametervalues-id PrimitiveType: String UpdateType: Mutable .PARAMETER StringValue + The field value, expressed as a String. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html#cfn-datapipeline-pipeline-parametervalues-stringvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineObject.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineObject.ps1 index 2ead46db4..ba3461990 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineObject.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineObject.ps1 @@ -1,16 +1,18 @@ function Add-VSDataPipelinePipelinePipelineObject { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline.PipelineObject resource property to the template. + Adds an AWS::DataPipeline::Pipeline.PipelineObject resource property to the template. PipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline. .DESCRIPTION Adds an AWS::DataPipeline::Pipeline.PipelineObject resource property to the template. - +PipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html .PARAMETER Fields + Key-value pairs that define the properties of the object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-fields DuplicatesAllowed: True ItemType: Field @@ -18,11 +20,15 @@ function Add-VSDataPipelinePipelinePipelineObject { UpdateType: Mutable .PARAMETER Id + The ID of the object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-id PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineTag.ps1 index fa57eca72..cbdb20546 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDataPipelinePipelinePipelineTag.ps1 @@ -1,21 +1,25 @@ function Add-VSDataPipelinePipelinePipelineTag { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline.PipelineTag resource property to the template. + Adds an AWS::DataPipeline::Pipeline.PipelineTag resource property to the template. A list of arbitrary tags (key-value pairs to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html in the *AWS Data Pipeline Developer Guide*. .DESCRIPTION Adds an AWS::DataPipeline::Pipeline.PipelineTag resource property to the template. - +A list of arbitrary tags (key-value pairs to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html in the *AWS Data Pipeline Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html .PARAMETER Key + The key name of a tag. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html#cfn-datapipeline-pipeline-pipelinetags-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value to associate with the key name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html#cfn-datapipeline-pipeline-pipelinetags-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceMicrosoftADVpcSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceMicrosoftADVpcSettings.ps1 index bfea42e2b..c53b42682 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceMicrosoftADVpcSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceMicrosoftADVpcSettings.ps1 @@ -1,16 +1,18 @@ function Add-VSDirectoryServiceMicrosoftADVpcSettings { <# .SYNOPSIS - Adds an AWS::DirectoryService::MicrosoftAD.VpcSettings resource property to the template. + Adds an AWS::DirectoryService::MicrosoftAD.VpcSettings resource property to the template. Contains VPC information for the CreateDirectory: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html or CreateMicrosoftAD: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html operation. .DESCRIPTION Adds an AWS::DirectoryService::MicrosoftAD.VpcSettings resource property to the template. - +Contains VPC information for the CreateDirectory: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html or CreateMicrosoftAD: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html operation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html .PARAMETER SubnetIds + The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-subnetids DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSDirectoryServiceMicrosoftADVpcSettings { UpdateType: Mutable .PARAMETER VpcId + The identifier of the VPC in which to create the directory. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-vpcid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceSimpleADVpcSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceSimpleADVpcSettings.ps1 index 398d2f17d..86c7d6f3b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceSimpleADVpcSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDirectoryServiceSimpleADVpcSettings.ps1 @@ -1,16 +1,18 @@ function Add-VSDirectoryServiceSimpleADVpcSettings { <# .SYNOPSIS - Adds an AWS::DirectoryService::SimpleAD.VpcSettings resource property to the template. + Adds an AWS::DirectoryService::SimpleAD.VpcSettings resource property to the template. Contains VPC information for the CreateDirectory: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html or CreateMicrosoftAD: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html operation. .DESCRIPTION Adds an AWS::DirectoryService::SimpleAD.VpcSettings resource property to the template. - +Contains VPC information for the CreateDirectory: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html or CreateMicrosoftAD: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html operation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html .PARAMETER SubnetIds + The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-subnetids DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSDirectoryServiceSimpleADVpcSettings { UpdateType: Mutable .PARAMETER VpcId + The identifier of the VPC in which to create the directory. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-vpcid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableAttributeDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableAttributeDefinition.ps1 index 782845bfc..536538d5e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableAttributeDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableAttributeDefinition.ps1 @@ -1,21 +1,28 @@ function Add-VSDynamoDBTableAttributeDefinition { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.AttributeDefinition resource property to the template. + Adds an AWS::DynamoDB::Table.AttributeDefinition resource property to the template. Represents an attribute for describing the key schema for the table and indexes. .DESCRIPTION Adds an AWS::DynamoDB::Table.AttributeDefinition resource property to the template. - +Represents an attribute for describing the key schema for the table and indexes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html .PARAMETER AttributeName + A name for the attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename PrimitiveType: String UpdateType: Mutable .PARAMETER AttributeType + The data type for the attribute, where: ++ S - the attribute is of type String ++ N - the attribute is of type Number ++ B - the attribute is of type Binary + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename-attributetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 index 0feb3f4ee..d0daa057e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 @@ -1,21 +1,29 @@ function Add-VSDynamoDBTableGlobalSecondaryIndex { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.GlobalSecondaryIndex resource property to the template. + Adds an AWS::DynamoDB::Table.GlobalSecondaryIndex resource property to the template. Represents the properties of a global secondary index. .DESCRIPTION Adds an AWS::DynamoDB::Table.GlobalSecondaryIndex resource property to the template. - +Represents the properties of a global secondary index. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html .PARAMETER IndexName + The name of the global secondary index. The name must be unique among all other indexes on this table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-indexname PrimitiveType: String UpdateType: Mutable .PARAMETER KeySchema + The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: ++ HASH - partition key ++ RANGE - sort key +The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. +The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-keyschema DuplicatesAllowed: False ItemType: KeySchema @@ -23,11 +31,16 @@ function Add-VSDynamoDBTableGlobalSecondaryIndex { UpdateType: Mutable .PARAMETER Projection + Represents attributes that are copied projected from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-projection Type: Projection UpdateType: Mutable .PARAMETER ProvisionedThroughput + Represents the provisioned throughput settings for the specified global secondary index. +For current minimum and maximum provisioned throughput values, see Limits: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html in the *Amazon DynamoDB Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-provisionedthroughput Type: ProvisionedThroughput UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 index b8f0a075c..db5c8a483 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 @@ -1,21 +1,33 @@ function Add-VSDynamoDBTableKeySchema { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.KeySchema resource property to the template. + Adds an AWS::DynamoDB::Table.KeySchema resource property to the template. Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. .DESCRIPTION Adds an AWS::DynamoDB::Table.KeySchema resource property to the template. +Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. +A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key. A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key. + +A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute. The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html .PARAMETER AttributeName + The name of a key attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-attributename PrimitiveType: String UpdateType: Mutable .PARAMETER KeyType + The role that this key attribute will assume: ++ HASH - partition key ++ RANGE - sort key +The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. +The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-keytype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 index 53b119043..8d1a1e5f3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 @@ -1,21 +1,29 @@ function Add-VSDynamoDBTableLocalSecondaryIndex { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.LocalSecondaryIndex resource property to the template. + Adds an AWS::DynamoDB::Table.LocalSecondaryIndex resource property to the template. Represents the properties of a local secondary index. .DESCRIPTION Adds an AWS::DynamoDB::Table.LocalSecondaryIndex resource property to the template. - +Represents the properties of a local secondary index. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html .PARAMETER IndexName + The name of the local secondary index. The name must be unique among all other indexes on this table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-indexname PrimitiveType: String UpdateType: Mutable .PARAMETER KeySchema + The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: ++ HASH - partition key ++ RANGE - sort key +The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. +The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-keyschema DuplicatesAllowed: False ItemType: KeySchema @@ -23,6 +31,8 @@ function Add-VSDynamoDBTableLocalSecondaryIndex { UpdateType: Mutable .PARAMETER Projection + Represents attributes that are copied projected from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-projection Type: Projection UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTablePointInTimeRecoverySpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTablePointInTimeRecoverySpecification.ps1 index c56d559dd..b3d4c6953 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTablePointInTimeRecoverySpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTablePointInTimeRecoverySpecification.ps1 @@ -1,16 +1,18 @@ function Add-VSDynamoDBTablePointInTimeRecoverySpecification { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.PointInTimeRecoverySpecification resource property to the template. + Adds an AWS::DynamoDB::Table.PointInTimeRecoverySpecification resource property to the template. The settings used to enable point in time recovery. .DESCRIPTION Adds an AWS::DynamoDB::Table.PointInTimeRecoverySpecification resource property to the template. - +The settings used to enable point in time recovery. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html .PARAMETER PointInTimeRecoveryEnabled + Indicates whether point in time recovery is enabled true or disabled false on the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 index 68f5b1a21..fc2abde11 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 @@ -1,16 +1,19 @@ function Add-VSDynamoDBTableProjection { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.Projection resource property to the template. + Adds an AWS::DynamoDB::Table.Projection resource property to the template. Represents attributes that are copied (projected from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. .DESCRIPTION Adds an AWS::DynamoDB::Table.Projection resource property to the template. - +Represents attributes that are copied (projected from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html .PARAMETER NonKeyAttributes + Represents the non-key attribute names which will be projected into the index. +For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-nonkeyatt DuplicatesAllowed: True PrimitiveItemType: String @@ -18,6 +21,11 @@ function Add-VSDynamoDBTableProjection { UpdateType: Mutable .PARAMETER ProjectionType + The set of attributes that are projected into the index: ++ KEYS_ONLY - Only the index and primary keys are projected into the index. ++ INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ++ ALL - All of the table attributes are projected into the index. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-projtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProvisionedThroughput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProvisionedThroughput.ps1 index 626cbe933..9bf88d593 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProvisionedThroughput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProvisionedThroughput.ps1 @@ -1,21 +1,27 @@ function Add-VSDynamoDBTableProvisionedThroughput { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.ProvisionedThroughput resource property to the template. + Adds an AWS::DynamoDB::Table.ProvisionedThroughput resource property to the template. Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html. .DESCRIPTION Adds an AWS::DynamoDB::Table.ProvisionedThroughput resource property to the template. - +Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html .PARAMETER ReadCapacityUnits + The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput in the *Amazon DynamoDB Developer Guide*. +If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-readcapacityunits PrimitiveType: Long UpdateType: Mutable .PARAMETER WriteCapacityUnits + The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput in the *Amazon DynamoDB Developer Guide*. +If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-writecapacityunits PrimitiveType: Long UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 index 502aee857..ff0855e57 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 @@ -1,26 +1,33 @@ function Add-VSDynamoDBTableSSESpecification { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.SSESpecification resource property to the template. + Adds an AWS::DynamoDB::Table.SSESpecification resource property to the template. Represents the settings used to enable server-side encryption. .DESCRIPTION Adds an AWS::DynamoDB::Table.SSESpecification resource property to the template. - +Represents the settings used to enable server-side encryption. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html .PARAMETER KMSMasterKeyId + The KMS customer master key CMK that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name ARN, alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB customer master key alias/aws/dynamodb. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-kmsmasterkeyid PrimitiveType: String UpdateType: Mutable .PARAMETER SSEEnabled + Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled true, server-side encryption type is set to KMS and an AWS managed CMK is used AWS KMS charges apply. If disabled false or not specified, server-side encryption is set to AWS owned CMK. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-sseenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SSEType + Server-side encryption type. The only supported value is: ++ KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account and is managed by AWS KMS AWS KMS charges apply. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-ssetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableStreamSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableStreamSpecification.ps1 index b37bc1d92..5e9573f53 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableStreamSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableStreamSpecification.ps1 @@ -1,16 +1,22 @@ function Add-VSDynamoDBTableStreamSpecification { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.StreamSpecification resource property to the template. + Adds an AWS::DynamoDB::Table.StreamSpecification resource property to the template. Represents the DynamoDB Streams configuration for a table in DynamoDB. .DESCRIPTION Adds an AWS::DynamoDB::Table.StreamSpecification resource property to the template. - +Represents the DynamoDB Streams configuration for a table in DynamoDB. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html .PARAMETER StreamViewType + When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are: ++ KEYS_ONLY - Only the key attributes of the modified item are written to the stream. ++ NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. ++ OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. ++ NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html#cfn-dynamodb-streamspecification-streamviewtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 index c6035ff28..666c256c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 @@ -1,21 +1,25 @@ function Add-VSDynamoDBTableTimeToLiveSpecification { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.TimeToLiveSpecification resource property to the template. + Adds an AWS::DynamoDB::Table.TimeToLiveSpecification resource property to the template. Represents the settings used to enable or disable Time to Live for the specified table. .DESCRIPTION Adds an AWS::DynamoDB::Table.TimeToLiveSpecification resource property to the template. - +Represents the settings used to enable or disable Time to Live for the specified table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html .PARAMETER AttributeName + The name of the Time to Live attribute used to store the expiration time for items in the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-attributename PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Indicates whether Time To Live is to be enabled true or disabled false on the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 index 21c284c5a..d6816c8a3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2CapacityReservationTagSpecification { <# .SYNOPSIS - Adds an AWS::EC2::CapacityReservation.TagSpecification resource property to the template. + Adds an AWS::EC2::CapacityReservation.TagSpecification resource property to the template. An array of key-value pairs to apply to this resource. .DESCRIPTION Adds an AWS::EC2::CapacityReservation.TagSpecification resource property to the template. +An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html .PARAMETER ResourceType + The type of resource to tag. Specify capacity-reservation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-resourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to apply to the resource. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointCertificateAuthenticationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointCertificateAuthenticationRequest.ps1 index 6c26387b6..797117b6a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointCertificateAuthenticationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointCertificateAuthenticationRequest.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2ClientVpnEndpointCertificateAuthenticationRequest { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest resource property to the template. + Adds an AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest resource property to the template. Information about the client certificate to be used for authentication. .DESCRIPTION Adds an AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest resource property to the template. - +Information about the client certificate to be used for authentication. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html .PARAMETER ClientRootCertificateChainArn + The ARN of the client certificate. The certificate must be signed by a certificate authority CA and it must be provisioned in AWS Certificate Manager ACM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html#cfn-ec2-clientvpnendpoint-certificateauthenticationrequest-clientrootcertificatechainarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointClientAuthenticationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointClientAuthenticationRequest.ps1 index 7409fb726..36f206e0c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointClientAuthenticationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointClientAuthenticationRequest.ps1 @@ -1,26 +1,32 @@ function Add-VSEC2ClientVpnEndpointClientAuthenticationRequest { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest resource property to the template. + Adds an AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest resource property to the template. Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication in the *AWS Client VPN Administrator Guide*. .DESCRIPTION Adds an AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest resource property to the template. - +Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication in the *AWS Client VPN Administrator Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html .PARAMETER MutualAuthentication + Information about the authentication certificates to be used, if applicable. You must provide this information if **Type** is certificate-authentication. + Type: CertificateAuthenticationRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication UpdateType: Mutable .PARAMETER Type + The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type PrimitiveType: String UpdateType: Mutable .PARAMETER ActiveDirectory + Information about the Active Directory to be used, if applicable. You must provide this information if **Type** is directory-service-authentication. + Type: DirectoryServiceAuthenticationRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointConnectionLogOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointConnectionLogOptions.ps1 index bbede7768..efb589287 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointConnectionLogOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointConnectionLogOptions.ps1 @@ -1,26 +1,32 @@ function Add-VSEC2ClientVpnEndpointConnectionLogOptions { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions resource property to the template. + Adds an AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions resource property to the template. Describes the client connection logging options for the Client VPN endpoint. .DESCRIPTION Adds an AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions resource property to the template. - +Describes the client connection logging options for the Client VPN endpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html .PARAMETER CloudwatchLogStream + The name of the CloudWatch Logs log stream to which the connection data is published. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchlogstream PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Indicates whether connection logging is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CloudwatchLogGroup + The name of the CloudWatch Logs log group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchloggroup PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointDirectoryServiceAuthenticationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointDirectoryServiceAuthenticationRequest.ps1 index 1d6b4177d..7005b8580 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointDirectoryServiceAuthenticationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointDirectoryServiceAuthenticationRequest.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2ClientVpnEndpointDirectoryServiceAuthenticationRequest { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest resource property to the template. + Adds an AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest resource property to the template. Describes the Active Directory to be used for client authentication. .DESCRIPTION Adds an AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest resource property to the template. - +Describes the Active Directory to be used for client authentication. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html .PARAMETER DirectoryId + The ID of the Active Directory to be used for authentication. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html#cfn-ec2-clientvpnendpoint-directoryserviceauthenticationrequest-directoryid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 index 0a7a5fbdd..183ada9e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2ClientVpnEndpointTagSpecification { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnEndpoint.TagSpecification resource property to the template. + Adds an AWS::EC2::ClientVpnEndpoint.TagSpecification resource property to the template. The tags to apply to a resource when the resource is being created. .DESCRIPTION Adds an AWS::EC2::ClientVpnEndpoint.TagSpecification resource property to the template. - +The tags to apply to a resource when the resource is being created. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html .PARAMETER ResourceType + The type of resource to tag. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-resourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to apply to the resource. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateConfigRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateConfigRequest.ps1 index 337013793..10b593548 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateConfigRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateConfigRequest.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2EC2FleetFleetLaunchTemplateConfigRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest resource property to the template. Specifies a launch template and overrides for an EC2 Fleet. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest resource property to the template. +Specifies a launch template and overrides for an EC2 Fleet. +FleetLaunchTemplateConfigRequest is a property of the AWS::EC2::EC2Fleet: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html .PARAMETER LaunchTemplateSpecification + The launch template to use. You must specify either the launch template ID or launch template name in the request. + Type: FleetLaunchTemplateSpecificationRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-launchtemplatespecification UpdateType: Mutable .PARAMETER Overrides + Any parameters that you specify override the same parameters in the launch template. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-overrides ItemType: FleetLaunchTemplateOverridesRequest diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 index 208fef6c1..a097cdb96 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 @@ -1,41 +1,55 @@ function Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest resource property to the template. Specifies overrides for a launch template for an EC2 Fleet. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest resource property to the template. +Specifies overrides for a launch template for an EC2 Fleet. +FleetLaunchTemplateOverridesRequest is a property of the FleetLaunchTemplateConfigRequest: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html .PARAMETER WeightedCapacity + The number of units provided by the specified instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-weightedcapacity PrimitiveType: Double UpdateType: Mutable .PARAMETER Priority + The priority for the launch template override. If **AllocationStrategy** is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-priority PrimitiveType: Double UpdateType: Mutable .PARAMETER AvailabilityZone + The Availability Zone in which to launch the instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet in which to launch the instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-subnetid PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER MaxPrice + The maximum price per unit hour that you are willing to pay for a Spot Instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-maxprice PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 index cdcc8c278..84201b513 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 @@ -1,26 +1,34 @@ function Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest resource property to the template. Specifies the launch template to use for an EC2 Fleet. You must specify either the launch template ID or launch template name in the request. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest resource property to the template. +Specifies the launch template to use for an EC2 Fleet. You must specify either the launch template ID or launch template name in the request. +FleetLaunchTemplateSpecificationRequest is a property of the FleetLaunchTemplateConfigRequest: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html .PARAMETER LaunchTemplateName + The name of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplatename PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The version number of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-version PrimitiveType: String UpdateType: Mutable .PARAMETER LaunchTemplateId + The ID of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplateid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetOnDemandOptionsRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetOnDemandOptionsRequest.ps1 index 1e7d2fb2f..23f6983b0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetOnDemandOptionsRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetOnDemandOptionsRequest.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2EC2FleetOnDemandOptionsRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.OnDemandOptionsRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.OnDemandOptionsRequest resource property to the template. Specifies the allocation strategy of On-Demand Instances in an EC2 Fleet. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.OnDemandOptionsRequest resource property to the template. +Specifies the allocation strategy of On-Demand Instances in an EC2 Fleet. +OnDemandOptionsRequest is a property of the AWS::EC2::EC2Fleet: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html .PARAMETER AllocationStrategy + The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-allocationstrategy PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 index 3079ba455..7d2d468b0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 @@ -1,26 +1,34 @@ function Add-VSEC2EC2FleetSpotOptionsRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.SpotOptionsRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.SpotOptionsRequest resource property to the template. Specifies the configuration of Spot Instances for an EC2 Fleet. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.SpotOptionsRequest resource property to the template. +Specifies the configuration of Spot Instances for an EC2 Fleet. +SpotOptionsRequest is a property of the AWS::EC2::EC2Fleet: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html .PARAMETER AllocationStrategy + Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-allocationstrategy PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceInterruptionBehavior + The behavior when a Spot Instance is interrupted. The default is terminate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instanceinterruptionbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER InstancePoolsToUseCount + The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot **AllocationStrategy** is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instancepoolstousecount PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagRequest.ps1 index 6b3d6492d..9aa63e39f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagRequest.ps1 @@ -1,21 +1,29 @@ function Add-VSEC2EC2FleetTagRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.TagRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.TagRequest resource property to the template. Specifies the tag key and value pair to use. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.TagRequest resource property to the template. +Specifies the tag key and value pair to use. +TagRequest is a property of the AWS::EC2::TagSpecification: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagrequest.html .PARAMETER Value + The key of the tag. +Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagrequest.html#cfn-ec2-ec2fleet-tagrequest-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The value of the tag. +Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagrequest.html#cfn-ec2-ec2fleet-tagrequest-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagSpecification.ps1 index d593a9938..e40f2bbee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTagSpecification.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2EC2FleetTagSpecification { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.TagSpecification resource property to the template. + Adds an AWS::EC2::EC2Fleet.TagSpecification resource property to the template. Specifies the tags to apply to a resource when the resource is being created for an EC2 Fleet. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.TagSpecification resource property to the template. +Specifies the tags to apply to a resource when the resource is being created for an EC2 Fleet. +TagSpecification is a property of the AWS::EC2::EC2Fleet: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html .PARAMETER ResourceType + The type of resource to tag. ResourceType must be fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-resourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to apply to the resource. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-tags ItemType: TagRequest diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTargetCapacitySpecificationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTargetCapacitySpecificationRequest.ps1 index b9c142257..594c11bba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTargetCapacitySpecificationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetTargetCapacitySpecificationRequest.ps1 @@ -1,31 +1,41 @@ function Add-VSEC2EC2FleetTargetCapacitySpecificationRequest { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest resource property to the template. + Adds an AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest resource property to the template. Specifies the number of units to request for an EC2 Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later. .DESCRIPTION Adds an AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest resource property to the template. +Specifies the number of units to request for an EC2 Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later. +TargetCapacitySpecificationRequest is a property of the AWS::EC2::EC2Fleet: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html .PARAMETER DefaultTargetCapacityType + The default TotalTargetCapacity, which is either Spot or On-Demand. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-defaulttargetcapacitytype PrimitiveType: String UpdateType: Mutable .PARAMETER TotalTargetCapacity + The number of units to request, filled using DefaultTargetCapacityType. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-totaltargetcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER OnDemandTargetCapacity + The number of On-Demand units to request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-ondemandtargetcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER SpotTargetCapacity + The number of Spot units to request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-spottargetcapacity PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceAssociationParameter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceAssociationParameter.ps1 index 325c78161..f9e9aae1d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceAssociationParameter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceAssociationParameter.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2InstanceAssociationParameter { <# .SYNOPSIS - Adds an AWS::EC2::Instance.AssociationParameter resource property to the template. + Adds an AWS::EC2::Instance.AssociationParameter resource property to the template. Specifies input parameter values for an SSM document in AWS Systems Manager. .DESCRIPTION Adds an AWS::EC2::Instance.AssociationParameter resource property to the template. +Specifies input parameter values for an SSM document in AWS Systems Manager. +AssociationParameter is a property of the Amazon EC2 Instance SsmAssociation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html property. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html .PARAMETER Key + The name of an input parameter that is in the associated SSM document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of an input parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-value DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceBlockDeviceMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceBlockDeviceMapping.ps1 index 52203e6f9..8e4bed93a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceBlockDeviceMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceBlockDeviceMapping.ps1 @@ -1,31 +1,45 @@ function Add-VSEC2InstanceBlockDeviceMapping { <# .SYNOPSIS - Adds an AWS::EC2::Instance.BlockDeviceMapping resource property to the template. + Adds an AWS::EC2::Instance.BlockDeviceMapping resource property to the template. Specifies a block device mapping for an instance. .DESCRIPTION Adds an AWS::EC2::Instance.BlockDeviceMapping resource property to the template. +Specifies a block device mapping for an instance. +BlockDeviceMapping is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html .PARAMETER DeviceName + The device name for example, /dev/sdh or xvdh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-devicename PrimitiveType: String UpdateType: Mutable .PARAMETER Ebs + Parameters used to automatically set up EBS volumes when the instance is launched. +You can specify either VirtualName or Ebs, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-ebs Type: Ebs UpdateType: Mutable .PARAMETER NoDevice + Suppresses the specified device included in the block device mapping of the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-nodevice Type: NoDevice UpdateType: Mutable .PARAMETER VirtualName + The virtual device name ephemeralN. The name must be in the form ephemeral*X* where *X* is a number starting from zero 0. For example, an instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. +NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. +You can specify either VirtualName or Ebs, but not both. +*Constraints*: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-virtualname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCpuOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCpuOptions.ps1 index d4f4b5e6e..41551537a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCpuOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCpuOptions.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2InstanceCpuOptions { <# .SYNOPSIS - Adds an AWS::EC2::Instance.CpuOptions resource property to the template. + Adds an AWS::EC2::Instance.CpuOptions resource property to the template. The CPU options for the instance. .DESCRIPTION Adds an AWS::EC2::Instance.CpuOptions resource property to the template. - +The CPU options for the instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html .PARAMETER CoreCount + The number of CPU cores for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-corecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER ThreadsPerCore + The number of threads per CPU core. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-threadspercore PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCreditSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCreditSpecification.ps1 index 2919a5cd0..7912e0040 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCreditSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceCreditSpecification.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2InstanceCreditSpecification { <# .SYNOPSIS - Adds an AWS::EC2::Instance.CreditSpecification resource property to the template. + Adds an AWS::EC2::Instance.CreditSpecification resource property to the template. Specifies the credit option for CPU usage of a T2 or T3 instance. .DESCRIPTION Adds an AWS::EC2::Instance.CreditSpecification resource property to the template. +Specifies the credit option for CPU usage of a T2 or T3 instance. +CreditSpecification is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html .PARAMETER CPUCredits + The credit option for CPU usage of the instance. Valid values are standard and unlimited. T3 instances launch as unlimited by default. T2 instances launch as standard by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html#cfn-ec2-instance-creditspecification-cpucredits PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 index 7b876f356..f7c57c28c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 @@ -1,46 +1,69 @@ function Add-VSEC2InstanceEbs { <# .SYNOPSIS - Adds an AWS::EC2::Instance.Ebs resource property to the template. + Adds an AWS::EC2::Instance.Ebs resource property to the template. Specifies a block device for an EBS volume. .DESCRIPTION Adds an AWS::EC2::Instance.Ebs resource property to the template. +Specifies a block device for an EBS volume. +Ebs is a property of the Amazon EC2 BlockDeviceMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html property. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html .PARAMETER DeleteOnTermination + Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination: url-doc-domain;AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination in the Amazon Elastic Compute Cloud User Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-deleteontermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Encrypted + Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin new or from a snapshot, starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default in the *Amazon Elastic Compute Cloud User Guide*. +Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon Elastic Compute Cloud User Guide*. +Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon Elastic Compute Cloud User Guide*. +Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER KmsKeyId + Identifier key ID, key alias, ID ARN, or alias ARN for a customer managed CMK under which the EBS volume is encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-instance-ebs-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER SnapshotId + The ID of the snapshot. +If you specify both SnapshotId and VolumeSize,VolumeSize must be equal or greater than the size of the snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-snapshotid PrimitiveType: String UpdateType: Mutable .PARAMETER VolumeSize + The size of the volume, in GiB. +Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. +Constraints: 1-16384 for General Purpose SSD gp2, 4-16384 for Provisioned IOPS SSD io1, 500-16384 for Throughput Optimized HDD st1, 500-16384 for Cold HDD sc1, and 1-1024 for Magnetic standard volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type. If you set the type to io1, you must also specify the IOPS that the volume supports. +Default: gp2 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 index 8e02e1335..fb1c12c2e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2InstanceElasticGpuSpecification { <# .SYNOPSIS - Adds an AWS::EC2::Instance.ElasticGpuSpecification resource property to the template. + Adds an AWS::EC2::Instance.ElasticGpuSpecification resource property to the template. Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html in the *Amazon EC2 User Guide for Windows Instances*. .DESCRIPTION Adds an AWS::EC2::Instance.ElasticGpuSpecification resource property to the template. +Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html in the *Amazon EC2 User Guide for Windows Instances*. +ElasticGpuSpecification is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html .PARAMETER Type + The type of Elastic Graphics accelerator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 index 699ac7bc8..e784733d4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2InstanceElasticInferenceAccelerator { <# .SYNOPSIS - Adds an AWS::EC2::Instance.ElasticInferenceAccelerator resource property to the template. + Adds an AWS::EC2::Instance.ElasticInferenceAccelerator resource property to the template. Specifies the Elastic Inference Accelerator for the instance. .DESCRIPTION Adds an AWS::EC2::Instance.ElasticInferenceAccelerator resource property to the template. +Specifies the Elastic Inference Accelerator for the instance. +ElasticInferenceAccelerator is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html .PARAMETER Count + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Type + The type of elastic inference accelerator. The possible values are eia1.small, eia1.medium, and eia1.large. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceInstanceIpv6Address.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceInstanceIpv6Address.ps1 index 8ddbc45e5..6f749132c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceInstanceIpv6Address.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceInstanceIpv6Address.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2InstanceInstanceIpv6Address { <# .SYNOPSIS - Adds an AWS::EC2::Instance.InstanceIpv6Address resource property to the template. + Adds an AWS::EC2::Instance.InstanceIpv6Address resource property to the template. Specifies the IPv6 address for the instance. .DESCRIPTION Adds an AWS::EC2::Instance.InstanceIpv6Address resource property to the template. +Specifies the IPv6 address for the instance. +InstanceIpv6Address is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html .PARAMETER Ipv6Address + The IPv6 address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html#cfn-ec2-instance-instanceipv6address-ipv6address PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLaunchTemplateSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLaunchTemplateSpecification.ps1 index c7c7d4366..8e9f0784f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLaunchTemplateSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLaunchTemplateSpecification.ps1 @@ -1,26 +1,34 @@ function Add-VSEC2InstanceLaunchTemplateSpecification { <# .SYNOPSIS - Adds an AWS::EC2::Instance.LaunchTemplateSpecification resource property to the template. + Adds an AWS::EC2::Instance.LaunchTemplateSpecification resource property to the template. Specifies a launch template. You must specify either the launch template ID or launch template name. .DESCRIPTION Adds an AWS::EC2::Instance.LaunchTemplateSpecification resource property to the template. +Specifies a launch template. You must specify either the launch template ID or launch template name. +LaunchTemplateSpecification is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html .PARAMETER LaunchTemplateId + The ID of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplateid PrimitiveType: String UpdateType: Mutable .PARAMETER LaunchTemplateName + The name of the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplatename PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The version number of the launch template.AWS CloudFormation does not support specifying $Latest, or $Default for the template version number. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLicenseSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLicenseSpecification.ps1 index 44a6d205a..c520bdae8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLicenseSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceLicenseSpecification.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2InstanceLicenseSpecification { <# .SYNOPSIS - Adds an AWS::EC2::Instance.LicenseSpecification resource property to the template. + Adds an AWS::EC2::Instance.LicenseSpecification resource property to the template. Specifies the license configuration to use. .DESCRIPTION Adds an AWS::EC2::Instance.LicenseSpecification resource property to the template. +Specifies the license configuration to use. +LicenseSpecification is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html .PARAMETER LicenseConfigurationArn + The Amazon Resource Name ARN of the license configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html#cfn-ec2-instance-licensespecification-licenseconfigurationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 index 8e4ace8d0..d12d326aa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 @@ -1,36 +1,49 @@ function Add-VSEC2InstanceNetworkInterface { <# .SYNOPSIS - Adds an AWS::EC2::Instance.NetworkInterface resource property to the template. + Adds an AWS::EC2::Instance.NetworkInterface resource property to the template. Specifies a network interface that is to be attached to an instance. .DESCRIPTION Adds an AWS::EC2::Instance.NetworkInterface resource property to the template. +Specifies a network interface that is to be attached to an instance. +NetworkInterface is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html .PARAMETER AssociatePublicIpAddress + Whether or not to associates a public IPv4 address with eth0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-associatepubip PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DeleteOnTermination + If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-delete PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Description + The description of the network interface. Applies only if creating a network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-description PrimitiveType: String UpdateType: Mutable .PARAMETER DeviceIndex + The position of the network interface in the attachment order. A primary network interface has a device index of 0. +If you specify a network interface when launching an instance, you must specify the device index. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-deviceindex PrimitiveType: String UpdateType: Mutable .PARAMETER GroupSet + The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-groupset DuplicatesAllowed: True PrimitiveItemType: String @@ -38,11 +51,15 @@ function Add-VSEC2InstanceNetworkInterface { UpdateType: Mutable .PARAMETER Ipv6AddressCount + A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresscount PrimitiveType: Integer UpdateType: Mutable .PARAMETER Ipv6Addresses + The IPv6 addresses associated with the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresses DuplicatesAllowed: True ItemType: InstanceIpv6Address @@ -50,16 +67,22 @@ function Add-VSEC2InstanceNetworkInterface { UpdateType: Mutable .PARAMETER NetworkInterfaceId + The ID of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-network-iface PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateIpAddress + The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddress PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateIpAddresses + One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddresses DuplicatesAllowed: True ItemType: PrivateIpAddressSpecification @@ -67,11 +90,15 @@ function Add-VSEC2InstanceNetworkInterface { UpdateType: Mutable .PARAMETER SecondaryPrivateIpAddressCount + The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-secondprivateip PrimitiveType: Integer UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-subnetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNoDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNoDevice.ps1 index effbeb855..4c3d88d03 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNoDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNoDevice.ps1 @@ -1,11 +1,13 @@ function Add-VSEC2InstanceNoDevice { <# .SYNOPSIS - Adds an AWS::EC2::Instance.NoDevice resource property to the template. + Adds an AWS::EC2::Instance.NoDevice resource property to the template. Suppresses the specified device included in the block device mapping of the AMI. To suppress a device, specify an empty string. .DESCRIPTION Adds an AWS::EC2::Instance.NoDevice resource property to the template. +Suppresses the specified device included in the block device mapping of the AMI. To suppress a device, specify an empty string. +NoDevice is a property of the Amazon EC2 BlockDeviceMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html property. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-nodevice.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstancePrivateIpAddressSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstancePrivateIpAddressSpecification.ps1 index 311832ab4..3e3af40d6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstancePrivateIpAddressSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstancePrivateIpAddressSpecification.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2InstancePrivateIpAddressSpecification { <# .SYNOPSIS - Adds an AWS::EC2::Instance.PrivateIpAddressSpecification resource property to the template. + Adds an AWS::EC2::Instance.PrivateIpAddressSpecification resource property to the template. Describes a secondary private IPv4 address for a network interface. .DESCRIPTION Adds an AWS::EC2::Instance.PrivateIpAddressSpecification resource property to the template. - +Describes a secondary private IPv4 address for a network interface. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html .PARAMETER Primary + Sets the private IP address as the primary private address. You can set only one primary private IP address. If you don't specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PrivateIpAddress + The private IP address of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceSsmAssociation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceSsmAssociation.ps1 index da08a49a9..b77d2d913 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceSsmAssociation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceSsmAssociation.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2InstanceSsmAssociation { <# .SYNOPSIS - Adds an AWS::EC2::Instance.SsmAssociation resource property to the template. + Adds an AWS::EC2::Instance.SsmAssociation resource property to the template. Specifies the SSM document and parameter values in AWS Systems Manager to associate with an instance. .DESCRIPTION Adds an AWS::EC2::Instance.SsmAssociation resource property to the template. +Specifies the SSM document and parameter values in AWS Systems Manager to associate with an instance. +SsmAssociations is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html .PARAMETER AssociationParameters + The input parameter values to use with the associated SSM document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-associationparameters DuplicatesAllowed: True ItemType: AssociationParameter @@ -18,6 +22,8 @@ function Add-VSEC2InstanceSsmAssociation { UpdateType: Mutable .PARAMETER DocumentName + The name of an SSM document to associate with the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-documentname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceVolume.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceVolume.ps1 index 6d8be0d3c..708338ee7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceVolume.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceVolume.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2InstanceVolume { <# .SYNOPSIS - Adds an AWS::EC2::Instance.Volume resource property to the template. + Adds an AWS::EC2::Instance.Volume resource property to the template. Specifies a volume to attach to an instance. .DESCRIPTION Adds an AWS::EC2::Instance.Volume resource property to the template. +Specifies a volume to attach to an instance. +Volume is property is an embedded property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html .PARAMETER Device + The device name for example, /dev/sdh or xvdh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-device PrimitiveType: String UpdateType: Mutable .PARAMETER VolumeId + The ID of the EBS volume. The volume and instance must be within the same Availability Zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-volumeid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateBlockDeviceMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateBlockDeviceMapping.ps1 index a78753743..80597be0a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateBlockDeviceMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateBlockDeviceMapping.ps1 @@ -1,31 +1,41 @@ function Add-VSEC2LaunchTemplateBlockDeviceMapping { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.BlockDeviceMapping resource property to the template. + Adds an AWS::EC2::LaunchTemplate.BlockDeviceMapping resource property to the template. Information about a block device mapping for an Amazon EC2 launch template. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.BlockDeviceMapping resource property to the template. +Information about a block device mapping for an Amazon EC2 launch template. +BlockDeviceMapping is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html .PARAMETER Ebs + Parameters used to automatically set up EBS volumes when the instance is launched. + Type: Ebs Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs UpdateType: Mutable .PARAMETER NoDevice + Suppresses the specified device included in the block device mapping of the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice PrimitiveType: String UpdateType: Mutable .PARAMETER VirtualName + The virtual device name ephemeralN. Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname PrimitiveType: String UpdateType: Mutable .PARAMETER DeviceName + The device name for example, /dev/sdh or xvdh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationSpecification.ps1 index 38a3f845c..2b933908d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationSpecification.ps1 @@ -1,21 +1,29 @@ function Add-VSEC2LaunchTemplateCapacityReservationSpecification { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.CapacityReservationSpecification resource property to the template. + Adds an AWS::EC2::LaunchTemplate.CapacityReservationSpecification resource property to the template. Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.CapacityReservationSpecification resource property to the template. +Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time. +CapacityReservationSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html .PARAMETER CapacityReservationPreference + Indicates the instance's Capacity Reservation preferences. Possible preferences include: ++ open - The instance can run in any open Capacity Reservation that has matching attributes instance type, platform, Availability Zone. ++ none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. + Type: CapacityReservationPreference Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification-capacityreservationpreference UpdateType: Mutable .PARAMETER CapacityReservationTarget + Information about the target Capacity Reservation. + Type: CapacityReservationTarget Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification-capacityreservationtarget UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationTarget.ps1 index 7be2f5bd6..865612017 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCapacityReservationTarget.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2LaunchTemplateCapacityReservationTarget { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.CapacityReservationTarget resource property to the template. + Adds an AWS::EC2::LaunchTemplate.CapacityReservationTarget resource property to the template. Specifies a target Capacity Reservation. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.CapacityReservationTarget resource property to the template. +Specifies a target Capacity Reservation. +CapacityReservationTarget is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html .PARAMETER CapacityReservationId + The ID of the Capacity Reservation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCpuOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCpuOptions.ps1 index 66fa7e11c..1bd3fe463 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCpuOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCpuOptions.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2LaunchTemplateCpuOptions { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.CpuOptions resource property to the template. + Adds an AWS::EC2::LaunchTemplate.CpuOptions resource property to the template. Specifies the CPU options for an instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.CpuOptions resource property to the template. +Specifies the CPU options for an instance. +CpuOptions is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html .PARAMETER ThreadsPerCore + The number of CPU cores for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions-threadspercore PrimitiveType: Integer UpdateType: Mutable .PARAMETER CoreCount + The number of CPU cores for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions-corecount PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCreditSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCreditSpecification.ps1 index 1b115ca25..60651f1de 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCreditSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateCreditSpecification.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2LaunchTemplateCreditSpecification { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.CreditSpecification resource property to the template. + Adds an AWS::EC2::LaunchTemplate.CreditSpecification resource property to the template. Specifies the credit option for CPU usage of a T2 or T3 instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.CreditSpecification resource property to the template. +Specifies the credit option for CPU usage of a T2 or T3 instance. +CreditSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-creditspecification.html .PARAMETER CpuCredits + The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-creditspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification-cpucredits PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 index 2f63b7575..03f8638cc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 @@ -1,46 +1,64 @@ function Add-VSEC2LaunchTemplateEbs { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.Ebs resource property to the template. + Adds an AWS::EC2::LaunchTemplate.Ebs resource property to the template. Parameters for a block device for an EBS volume in an Amazon EC2 launch template. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.Ebs resource property to the template. +Parameters for a block device for an EBS volume in an Amazon EC2 launch template. +Ebs is a property of the Amazon EC2 LaunchTemplate BlockDeviceMapping: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html .PARAMETER SnapshotId + The ID of the snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-snapshotid PrimitiveType: String UpdateType: Mutable .PARAMETER VolumeType + The volume type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumetype PrimitiveType: String UpdateType: Mutable .PARAMETER KmsKeyId + The ARN of the AWS Key Management Service AWS KMS CMK used for encryption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-kmskeyid PrimitiveType: String UpdateType: Mutable .PARAMETER Encrypted + Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon Elastic Compute Cloud User Guide*. +Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeSize + The size of the volume, in GiB. +Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER DeleteOnTermination + Indicates whether the EBS volume is deleted on instance termination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-deleteontermination PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 index 5d53140bf..bc789ddf2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2LaunchTemplateElasticGpuSpecification { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.ElasticGpuSpecification resource property to the template. + Adds an AWS::EC2::LaunchTemplate.ElasticGpuSpecification resource property to the template. Specifies a specification for an Elastic GPU for an Amazon EC2 launch template. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.ElasticGpuSpecification resource property to the template. +Specifies a specification for an Elastic GPU for an Amazon EC2 launch template. +ElasticGpuSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html .PARAMETER Type + The type of Elastic Graphics accelerator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html#cfn-ec2-launchtemplate-elasticgpuspecification-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateHibernationOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateHibernationOptions.ps1 index 9ccdaccf6..6c83b8ee8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateHibernationOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateHibernationOptions.ps1 @@ -1,16 +1,21 @@ function Add-VSEC2LaunchTemplateHibernationOptions { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.HibernationOptions resource property to the template. + Adds an AWS::EC2::LaunchTemplate.HibernationOptions resource property to the template. Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html in the *Amazon Elastic Compute Cloud User Guide*. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.HibernationOptions resource property to the template. +Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html in the *Amazon Elastic Compute Cloud User Guide*. +HibernationOptions is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-hibernationoptions.html .PARAMETER Configured + If you set this parameter to true, the instance is enabled for hibernation. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-hibernationoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions-configured PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIamInstanceProfile.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIamInstanceProfile.ps1 index 79c8b4c0e..2eeab19b5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIamInstanceProfile.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIamInstanceProfile.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2LaunchTemplateIamInstanceProfile { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.IamInstanceProfile resource property to the template. + Adds an AWS::EC2::LaunchTemplate.IamInstanceProfile resource property to the template. Specifies an IAM instance profile. You must provide either the name or the ARN of the instance profile. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.IamInstanceProfile resource property to the template. +Specifies an IAM instance profile. You must provide either the name or the ARN of the instance profile. +IamInstanceProfile is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html .PARAMETER Arn + The Amazon Resource Name ARN of the instance profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-arn PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the instance profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateInstanceMarketOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateInstanceMarketOptions.ps1 index 1b83c1906..c40d4e4bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateInstanceMarketOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateInstanceMarketOptions.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2LaunchTemplateInstanceMarketOptions { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.InstanceMarketOptions resource property to the template. + Adds an AWS::EC2::LaunchTemplate.InstanceMarketOptions resource property to the template. Specifies the market (purchasing option for an instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.InstanceMarketOptions resource property to the template. +Specifies the market (purchasing option for an instance. +InstanceMarketOptions is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html .PARAMETER SpotOptions + The options for Spot Instances. + Type: SpotOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions UpdateType: Mutable .PARAMETER MarketType + The market type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-markettype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIpv6Add.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIpv6Add.ps1 index 202070795..f5f3df1c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIpv6Add.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateIpv6Add.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2LaunchTemplateIpv6Add { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.Ipv6Add resource property to the template. + Adds an AWS::EC2::LaunchTemplate.Ipv6Add resource property to the template. Specifies an IPv6 address in an Amazon EC2 launch template. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.Ipv6Add resource property to the template. +Specifies an IPv6 address in an Amazon EC2 launch template. +Ipv6Add is a property of the Amazon EC2 LaunchTemplate NetworkInterface: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html .PARAMETER Ipv6Address + One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html#cfn-ec2-launchtemplate-ipv6add-ipv6address PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 index 3a602deee..3b0d80e3f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 @@ -1,149 +1,205 @@ function Add-VSEC2LaunchTemplateLaunchTemplateData { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.LaunchTemplateData resource property to the template. + Adds an AWS::EC2::LaunchTemplate.LaunchTemplateData resource property to the template. The information to include in the launch template. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.LaunchTemplateData resource property to the template. - +The information to include in the launch template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html .PARAMETER SecurityGroups + EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroups UpdateType: Mutable .PARAMETER TagSpecifications + The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications ItemType: TagSpecification UpdateType: Mutable .PARAMETER UserData + The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html Linux and Adding User Data: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data Windows. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-userdata PrimitiveType: String UpdateType: Mutable .PARAMETER BlockDeviceMappings + The block device mapping. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-blockdevicemappings ItemType: BlockDeviceMapping UpdateType: Mutable .PARAMETER IamInstanceProfile + The IAM instance profile. + Type: IamInstanceProfile Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile UpdateType: Mutable .PARAMETER KernelId + The ID of the kernel. +We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid PrimitiveType: String UpdateType: Mutable .PARAMETER EbsOptimized + Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ebsoptimized PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ElasticGpuSpecifications + An elastic GPU to associate with the instance. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticgpuspecifications ItemType: ElasticGpuSpecification UpdateType: Mutable .PARAMETER ElasticInferenceAccelerators + The elastic inference accelerator for the instance. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticinferenceaccelerators ItemType: LaunchTemplateElasticInferenceAccelerator UpdateType: Mutable .PARAMETER Placement + The placement for the instance. + Type: Placement Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-placement UpdateType: Mutable .PARAMETER NetworkInterfaces + One or more network interfaces. If you specify a network interface, you must specify any security groups as part of the network interface. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces ItemType: NetworkInterface UpdateType: Mutable .PARAMETER ImageId + The ID of the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-imageid PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type. For more information, see Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER Monitoring + The monitoring for the instance. + Type: Monitoring Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring UpdateType: Mutable .PARAMETER HibernationOptions + Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html in the *Amazon Elastic Compute Cloud User Guide*. + Type: HibernationOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions UpdateType: Mutable .PARAMETER MetadataOptions + + RequestLaunchTemplateData: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html in the *Amazon Elastic Compute Cloud API Reference* + Type: MetadataOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions UpdateType: Mutable .PARAMETER LicenseSpecifications + The license configurations. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-licensespecifications ItemType: LicenseSpecification UpdateType: Mutable .PARAMETER InstanceInitiatedShutdownBehavior + Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system command for system shutdown. +Default: stop + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instanceinitiatedshutdownbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER CpuOptions + The CPU options for the instance. For more information, see Optimizing CPU Options: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html in the *Amazon Elastic Compute Cloud User Guide*. + Type: CpuOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions UpdateType: Mutable .PARAMETER SecurityGroupIds + One or more security group IDs. You can create a security group using CreateSecurityGroup: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html. You cannot specify both a security group ID and security name in the same request. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroupids UpdateType: Mutable .PARAMETER KeyName + The name of the key pair. You can create a key pair using CreateKeyPair: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html or ImportKeyPair: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html. +If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-keyname PrimitiveType: String UpdateType: Mutable .PARAMETER DisableApiTermination + If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapitermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER InstanceMarketOptions + The market purchasing option for the instances. + Type: InstanceMarketOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions UpdateType: Mutable .PARAMETER RamDiskId + The ID of the RAM disk. +We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ramdiskid PrimitiveType: String UpdateType: Mutable .PARAMETER CapacityReservationSpecification + The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes instance type, platform, Availability Zone. + Type: CapacityReservationSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification UpdateType: Mutable .PARAMETER CreditSpecification + The credit option for CPU usage of the instance. Valid for T2 or T3 instances only. + Type: CreditSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 index 87172f92b..a8f2c16ab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.LaunchTemplateElasticInferenceAccelerator resource property to the template. + Adds an AWS::EC2::LaunchTemplate.LaunchTemplateElasticInferenceAccelerator resource property to the template. Specifies an elastic inference accelerator. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.LaunchTemplateElasticInferenceAccelerator resource property to the template. +Specifies an elastic inference accelerator. +LaunchTemplateElasticInferenceAccelerator is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html .PARAMETER Type + The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-type PrimitiveType: String UpdateType: Mutable .PARAMETER Count + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-count PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLicenseSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLicenseSpecification.ps1 index ceb8d2e32..1b8c64b06 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLicenseSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLicenseSpecification.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2LaunchTemplateLicenseSpecification { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.LicenseSpecification resource property to the template. + Adds an AWS::EC2::LaunchTemplate.LicenseSpecification resource property to the template. Specifies a license configuration for an instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.LicenseSpecification resource property to the template. +Specifies a license configuration for an instance. +LicenseSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html .PARAMETER LicenseConfigurationArn + The Amazon Resource Name ARN of the license configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html#cfn-ec2-launchtemplate-licensespecification-licenseconfigurationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMonitoring.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMonitoring.ps1 index 42c82fddd..2b2a6afb8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMonitoring.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMonitoring.ps1 @@ -1,16 +1,20 @@ function Add-VSEC2LaunchTemplateMonitoring { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.Monitoring resource property to the template. + Adds an AWS::EC2::LaunchTemplate.Monitoring resource property to the template. Specifies whether detailed monitoring is enabled for an instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.Monitoring resource property to the template. +Specifies whether detailed monitoring is enabled for an instance. +Monitoring is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-monitoring.html .PARAMETER Enabled + Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-monitoring.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateNetworkInterface.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateNetworkInterface.ps1 index 469a070f9..51923103a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateNetworkInterface.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateNetworkInterface.ps1 @@ -1,79 +1,109 @@ function Add-VSEC2LaunchTemplateNetworkInterface { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.NetworkInterface resource property to the template. + Adds an AWS::EC2::LaunchTemplate.NetworkInterface resource property to the template. Specifies the parameters for a network interface. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.NetworkInterface resource property to the template. +Specifies the parameters for a network interface. +NetworkInterface is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html .PARAMETER Description + A description for the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-description PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateIpAddress + The primary private IPv4 address of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddress PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateIpAddresses + One or more private IPv4 addresses. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddresses ItemType: PrivateIpAdd UpdateType: Mutable .PARAMETER SecondaryPrivateIpAddressCount + The number of secondary private IPv4 addresses to assign to a network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-secondaryprivateipaddresscount PrimitiveType: Integer UpdateType: Mutable .PARAMETER DeviceIndex + The device index for the network interface attachment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deviceindex PrimitiveType: Integer UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet for the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-subnetid PrimitiveType: String UpdateType: Mutable .PARAMETER Ipv6Addresses + One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresses ItemType: Ipv6Add UpdateType: Mutable .PARAMETER AssociatePublicIpAddress + Associates a public IPv4 address with eth0 for a new network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatepublicipaddress PrimitiveType: Boolean UpdateType: Mutable .PARAMETER NetworkInterfaceId + The ID of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkinterfaceid PrimitiveType: String UpdateType: Mutable .PARAMETER InterfaceType + The type of network interface. To create an Elastic Fabric Adapter EFA, specify efa. For more information, see Elastic Fabric Adapter: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html in the *Amazon Elastic Compute Cloud User Guide*. +If you are not creating an EFA, specify interface or omit this parameter. +Valid values: interface | efa + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-interfacetype PrimitiveType: String UpdateType: Mutable .PARAMETER Ipv6AddressCount + The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresscount PrimitiveType: Integer UpdateType: Mutable .PARAMETER Groups + The IDs of one or more security groups. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-groups UpdateType: Mutable .PARAMETER DeleteOnTermination + Indicates whether the network interface is deleted when the instance is terminated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deleteontermination PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 index ffd9fa2dd..ca96abcff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 @@ -1,51 +1,69 @@ function Add-VSEC2LaunchTemplatePlacement { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.Placement resource property to the template. + Adds an AWS::EC2::LaunchTemplate.Placement resource property to the template. Specifies the placement of an instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.Placement resource property to the template. +Specifies the placement of an instance. +Placement is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html .PARAMETER GroupName + The name of the placement group for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-groupname PrimitiveType: String UpdateType: Mutable .PARAMETER Tenancy + The tenancy of the instance if the instance is running in a VPC. An instance with a tenancy of dedicated runs on single-tenant hardware. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-tenancy PrimitiveType: String UpdateType: Mutable .PARAMETER SpreadDomain + + LaunchTemplatePlacementRequest: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplatePlacementRequest.html in the *Amazon Elastic Compute Cloud API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-spreaddomain PrimitiveType: String UpdateType: Mutable .PARAMETER PartitionNumber + + LaunchTemplatePlacementRequest: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplatePlacementRequest.html in the *Amazon Elastic Compute Cloud API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-partitionnumber PrimitiveType: Integer UpdateType: Mutable .PARAMETER AvailabilityZone + The Availability Zone for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER Affinity + The affinity setting for an instance on a Dedicated Host. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-affinity PrimitiveType: String UpdateType: Mutable .PARAMETER HostId + The ID of the Dedicated Host for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostid PrimitiveType: String UpdateType: Mutable .PARAMETER HostResourceGroupArn + + LaunchTemplatePlacementRequest: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplatePlacementRequest.html in the *Amazon Elastic Compute Cloud API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostresourcegrouparn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePrivateIpAdd.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePrivateIpAdd.ps1 index b3e620f85..a57715dff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePrivateIpAdd.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePrivateIpAdd.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2LaunchTemplatePrivateIpAdd { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.PrivateIpAdd resource property to the template. + Adds an AWS::EC2::LaunchTemplate.PrivateIpAdd resource property to the template. Specifies a secondary private IPv4 address for a network interface. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.PrivateIpAdd resource property to the template. +Specifies a secondary private IPv4 address for a network interface. +PrivateIpAdd is a property of the Amazon EC2 LaunchTemplate NetworkInterface: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html .PARAMETER PrivateIpAddress + The private IPv4 addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-privateipaddress PrimitiveType: String UpdateType: Mutable .PARAMETER Primary + Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-primary PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 index 91a544a10..ece789a39 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 @@ -1,36 +1,48 @@ function Add-VSEC2LaunchTemplateSpotOptions { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.SpotOptions resource property to the template. + Adds an AWS::EC2::LaunchTemplate.SpotOptions resource property to the template. Specifies options for Spot instances. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.SpotOptions resource property to the template. +Specifies options for Spot instances. +SpotOptions is a property of the Amazon EC2 LaunchTemplate InstanceMarketOptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancemarketoptions.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html .PARAMETER SpotInstanceType + The Spot Instance request type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-spotinstancetype PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceInterruptionBehavior + The behavior when a Spot Instance is interrupted. The default is terminate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-instanceinterruptionbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER MaxPrice + The maximum hourly price you're willing to pay for the Spot Instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-maxprice PrimitiveType: String UpdateType: Mutable .PARAMETER BlockDurationMinutes + The required duration for the Spot Instances also known as Spot blocks, in minutes. This value must be a multiple of 60 60, 120, 180, 240, 300, or 360. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-blockdurationminutes PrimitiveType: Integer UpdateType: Mutable .PARAMETER ValidUntil + The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-validuntil PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 index 1232089dc..a428b239b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 @@ -1,21 +1,27 @@ function Add-VSEC2LaunchTemplateTagSpecification { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.TagSpecification resource property to the template. + Adds an AWS::EC2::LaunchTemplate.TagSpecification resource property to the template. Specifies tags to apply to a resource when the resource is created. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.TagSpecification resource property to the template. +Specifies tags to apply to a resource when the resource is created. +TagSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html .PARAMETER ResourceType + The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-resourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to apply to the resource. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryIcmp.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryIcmp.ps1 index 75f7b37ae..9060f8bfd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryIcmp.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryIcmp.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2NetworkAclEntryIcmp { <# .SYNOPSIS - Adds an AWS::EC2::NetworkAclEntry.Icmp resource property to the template. + Adds an AWS::EC2::NetworkAclEntry.Icmp resource property to the template. Describes the ICMP type and code. .DESCRIPTION Adds an AWS::EC2::NetworkAclEntry.Icmp resource property to the template. - +Describes the ICMP type and code. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html .PARAMETER Code + The Internet Control Message Protocol ICMP code. You can use -1 to specify all ICMP codes for the given ICMP type. Requirement is conditional: Required if you specify 1 ICMP for the protocol parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-code PrimitiveType: Integer UpdateType: Mutable .PARAMETER Type + The Internet Control Message Protocol ICMP type. You can use -1 to specify all ICMP types. Conditional requirement: Required if you specify 1 ICMP for the CreateNetworkAclEntry protocol parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-type PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryPortRange.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryPortRange.ps1 index 035d4df86..0ce6dbe6d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryPortRange.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkAclEntryPortRange.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2NetworkAclEntryPortRange { <# .SYNOPSIS - Adds an AWS::EC2::NetworkAclEntry.PortRange resource property to the template. + Adds an AWS::EC2::NetworkAclEntry.PortRange resource property to the template. Describes a range of ports. .DESCRIPTION Adds an AWS::EC2::NetworkAclEntry.PortRange resource property to the template. - +Describes a range of ports. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html .PARAMETER From + The first port in the range. Required if you specify 6 TCP or 17 UDP for the protocol parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-from PrimitiveType: Integer UpdateType: Mutable .PARAMETER To + The last port in the range. Required if you specify 6 TCP or 17 UDP for the protocol parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-to PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfaceInstanceIpv6Address.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfaceInstanceIpv6Address.ps1 index 0143bf58c..ba25bb904 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfaceInstanceIpv6Address.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfaceInstanceIpv6Address.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2NetworkInterfaceInstanceIpv6Address { <# .SYNOPSIS - Adds an AWS::EC2::NetworkInterface.InstanceIpv6Address resource property to the template. + Adds an AWS::EC2::NetworkInterface.InstanceIpv6Address resource property to the template. Describes an IPv6 address to associate with the network interface. .DESCRIPTION Adds an AWS::EC2::NetworkInterface.InstanceIpv6Address resource property to the template. - +Describes an IPv6 address to associate with the network interface. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html .PARAMETER Ipv6Address + The IPv6 address to associate with the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html#cfn-ec2-networkinterface-instanceipv6address-ipv6address PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfacePrivateIpAddressSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfacePrivateIpAddressSpecification.ps1 index 58b8c6b4c..664e0d9ff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfacePrivateIpAddressSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2NetworkInterfacePrivateIpAddressSpecification.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2NetworkInterfacePrivateIpAddressSpecification { <# .SYNOPSIS - Adds an AWS::EC2::NetworkInterface.PrivateIpAddressSpecification resource property to the template. + Adds an AWS::EC2::NetworkInterface.PrivateIpAddressSpecification resource property to the template. Describes a secondary private IPv4 address for a network interface. .DESCRIPTION Adds an AWS::EC2::NetworkInterface.PrivateIpAddressSpecification resource property to the template. - +Describes a secondary private IPv4 address for a network interface. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html .PARAMETER Primary + Sets the private IP address as the primary private address. You can set only one primary private IP address. If you don't specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PrivateIpAddress + The private IP address of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 index 86f372c20..cad616eee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 @@ -1,51 +1,74 @@ function Add-VSEC2SecurityGroupEgress { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroup.Egress resource property to the template. + Adds an AWS::EC2::SecurityGroup.Egress resource property to the template. Specifies an outbound rule for a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups. .DESCRIPTION Adds an AWS::EC2::SecurityGroup.Egress resource property to the template. +Specifies an outbound rule for a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups. +You must specify only one of the following properties: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId. + +The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGroup type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html .PARAMETER CidrIp + The IPv4 address range, in CIDR format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip PrimitiveType: String UpdateType: Mutable .PARAMETER CidrIpv6 + EC2-VPC only] The IPv6 ranges. +The IPv6 address range, in CIDR format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6 PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description for the security group rule. +Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=;{}!$* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description PrimitiveType: String UpdateType: Mutable .PARAMETER DestinationPrefixListId + EC2-VPC only] The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destinationprefixlistid PrimitiveType: String UpdateType: Mutable .PARAMETER DestinationSecurityGroupId + The ID of the destination VPC security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destsecgroupid PrimitiveType: String UpdateType: Mutable .PARAMETER FromPort + The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport PrimitiveType: Integer UpdateType: Mutable .PARAMETER IpProtocol + The IP protocol name tcp, udp, icmp, icmpv6 or number see Protocol Numbers: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. +VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol PrimitiveType: String UpdateType: Mutable .PARAMETER ToPort + The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 index a3f5b292b..055b2cf48 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 @@ -1,61 +1,88 @@ function Add-VSEC2SecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroup.Ingress resource property to the template. + Adds an AWS::EC2::SecurityGroup.Ingress resource property to the template. Specifies an outbound rule for a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups. .DESCRIPTION Adds an AWS::EC2::SecurityGroup.Ingress resource property to the template. +Specifies an outbound rule for a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups. +You must specify only one of the following properties: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId. + +The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGroup type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html .PARAMETER CidrIp + The IPv4 address range, in CIDR format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip PrimitiveType: String UpdateType: Mutable .PARAMETER CidrIpv6 + EC2-VPC only] The IPv6 ranges. +The IPv6 address range, in CIDR format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6 PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description for the security group rule. +Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=;{}!$* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description PrimitiveType: String UpdateType: Mutable .PARAMETER FromPort + The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport PrimitiveType: Integer UpdateType: Mutable .PARAMETER IpProtocol + The IP protocol name tcp, udp, icmp, icmpv6 or number see Protocol Numbers: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. +VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol PrimitiveType: String UpdateType: Mutable .PARAMETER SourcePrefixListId + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-securitygroup-ingress-sourceprefixlistid PrimitiveType: String UpdateType: Mutable .PARAMETER SourceSecurityGroupId + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupid PrimitiveType: String UpdateType: Mutable .PARAMETER SourceSecurityGroupName + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER SourceSecurityGroupOwnerId + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupownerid PrimitiveType: String UpdateType: Mutable .PARAMETER ToPort + The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetBlockDeviceMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetBlockDeviceMapping.ps1 index 041013172..f25f5f115 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetBlockDeviceMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetBlockDeviceMapping.ps1 @@ -1,31 +1,43 @@ function Add-VSEC2SpotFleetBlockDeviceMapping { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.BlockDeviceMapping resource property to the template. + Adds an AWS::EC2::SpotFleet.BlockDeviceMapping resource property to the template. Specifies a block device mapping. .DESCRIPTION Adds an AWS::EC2::SpotFleet.BlockDeviceMapping resource property to the template. +Specifies a block device mapping. +You can specify Ebs or VirtualName, but not both. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html .PARAMETER DeviceName + The device name for example, /dev/sdh or xvdh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-devicename PrimitiveType: String UpdateType: Mutable .PARAMETER Ebs + Parameters used to automatically set up EBS volumes when the instance is launched. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-ebs Type: EbsBlockDevice UpdateType: Mutable .PARAMETER NoDevice + Suppresses the specified device included in the block device mapping of the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-nodevice PrimitiveType: String UpdateType: Mutable .PARAMETER VirtualName + The virtual device name ephemeralN. Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. +NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. +Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-virtualname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancer.ps1 index 0e6c70177..4026df495 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancer.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetClassicLoadBalancer { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.ClassicLoadBalancer resource property to the template. + Adds an AWS::EC2::SpotFleet.ClassicLoadBalancer resource property to the template. Specifies a Classic Load Balancer. .DESCRIPTION Adds an AWS::EC2::SpotFleet.ClassicLoadBalancer resource property to the template. - +Specifies a Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html .PARAMETER Name + The name of the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html#cfn-ec2-spotfleet-classicloadbalancer-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancersConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancersConfig.ps1 index b3c7148fd..30eac73fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancersConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetClassicLoadBalancersConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetClassicLoadBalancersConfig { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.ClassicLoadBalancersConfig resource property to the template. + Adds an AWS::EC2::SpotFleet.ClassicLoadBalancersConfig resource property to the template. Specifies the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers. .DESCRIPTION Adds an AWS::EC2::SpotFleet.ClassicLoadBalancersConfig resource property to the template. - +Specifies the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html .PARAMETER ClassicLoadBalancers + One or more Classic Load Balancers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html#cfn-ec2-spotfleet-classicloadbalancersconfig-classicloadbalancers DuplicatesAllowed: False ItemType: ClassicLoadBalancer diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 index b9dc1c1ce..661810eda 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 @@ -1,41 +1,60 @@ function Add-VSEC2SpotFleetEbsBlockDevice { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.EbsBlockDevice resource property to the template. + Adds an AWS::EC2::SpotFleet.EbsBlockDevice resource property to the template. Describes a block device for an EBS volume. .DESCRIPTION Adds an AWS::EC2::SpotFleet.EbsBlockDevice resource property to the template. - +Describes a block device for an EBS volume. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html .PARAMETER DeleteOnTermination + Indicates whether the EBS volume is deleted on instance termination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Encrypted + Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The default effect of setting the Encrypted parameter to true through the console, API, or CLI depends on the volume's origin new or from a snapshot, starting encryption state, ownership, and whether account-level encryption: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/account-level-encryption.html is enabled. Each default case can be overridden by specifying a customer master key CMK with the KmsKeyId parameter in addition to setting Encrypted to true. For a complete list of possible encryption cases, see Amazon EBS Encryption: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters in the *Amazon Elastic Compute Cloud User Guide*. +In no case can you remove encryption from an encrypted volume. +Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon Elastic Compute Cloud User Guide*. +Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon Elastic Compute Cloud User Guide*. +Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotId + The ID of the snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid PrimitiveType: String UpdateType: Mutable .PARAMETER VolumeSize + The size of the volume, in GiB. +Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. +Constraints: 1-16384 for General Purpose SSD gp2, 4-16384 for Provisioned IOPS SSD io1, 500-16384 for Throughput Optimized HDD st1, 500-16384 for Cold HDD sc1, and 1-1024 for Magnetic standard volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type. If you set the type to io1, you must also set the **Iops** property. +Default: standard + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetFleetLaunchTemplateSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetFleetLaunchTemplateSpecification.ps1 index 3d66166e1..289d7ca41 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetFleetLaunchTemplateSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetFleetLaunchTemplateSpecification.ps1 @@ -1,26 +1,34 @@ function Add-VSEC2SpotFleetFleetLaunchTemplateSpecification { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification resource property to the template. + Adds an AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification resource property to the template. Describes a launch template. .DESCRIPTION Adds an AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification resource property to the template. - +Describes a launch template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html .PARAMETER LaunchTemplateId + The ID of the launch template. You must specify either a template ID or a template name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplateid PrimitiveType: String UpdateType: Mutable .PARAMETER LaunchTemplateName + The name of the launch template. You must specify either a template name or a template ID. +Minimum length of 3. Maximum length of 128. Names must match the following pattern: a-zA-Z0-9.-/_]+ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplatename PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The version number of the launch template. You must specify a version number. AWS CloudFormation does not support specifying $Latest or $Default for the template version number. +Minimum length of 1. Maximum length of 255. Versions must fit the following pattern: u0020-uD7FFuE000-uFFFDuD800uDC00-uDBFFuDFFFrnt]* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetGroupIdentifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetGroupIdentifier.ps1 index e0f9721b0..6965f82e0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetGroupIdentifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetGroupIdentifier.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetGroupIdentifier { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.GroupIdentifier resource property to the template. + Adds an AWS::EC2::SpotFleet.GroupIdentifier resource property to the template. Describes a security group. .DESCRIPTION Adds an AWS::EC2::SpotFleet.GroupIdentifier resource property to the template. - +Describes a security group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-securitygroups.html .PARAMETER GroupId + The ID of the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-securitygroups.html#cfn-ec2-spotfleet-groupidentifier-groupid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetIamInstanceProfileSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetIamInstanceProfileSpecification.ps1 index 186bda52c..18edea71c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetIamInstanceProfileSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetIamInstanceProfileSpecification.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetIamInstanceProfileSpecification { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.IamInstanceProfileSpecification resource property to the template. + Adds an AWS::EC2::SpotFleet.IamInstanceProfileSpecification resource property to the template. Describes an IAM instance profile. .DESCRIPTION Adds an AWS::EC2::SpotFleet.IamInstanceProfileSpecification resource property to the template. - +Describes an IAM instance profile. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-iaminstanceprofile.html .PARAMETER Arn + The Amazon Resource Name ARN of the instance profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-iaminstanceprofile.html#cfn-ec2-spotfleet-iaminstanceprofilespecification-arn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceIpv6Address.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceIpv6Address.ps1 index 5d36244b5..37faca5ba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceIpv6Address.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceIpv6Address.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetInstanceIpv6Address { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.InstanceIpv6Address resource property to the template. + Adds an AWS::EC2::SpotFleet.InstanceIpv6Address resource property to the template. Describes an IPv6 address. .DESCRIPTION Adds an AWS::EC2::SpotFleet.InstanceIpv6Address resource property to the template. - +Describes an IPv6 address. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html .PARAMETER Ipv6Address + The IPv6 address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html#cfn-ec2-spotfleet-instanceipv6address-ipv6address PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 index dc350e90e..48af293d6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 @@ -1,36 +1,47 @@ function Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification resource property to the template. + Adds an AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification resource property to the template. Describes a network interface. .DESCRIPTION Adds an AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification resource property to the template. - +Describes a network interface. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html .PARAMETER AssociatePublicIpAddress + Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DeleteOnTermination + If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Description + The description of the network interface. Applies only if creating a network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description PrimitiveType: String UpdateType: Mutable .PARAMETER DeviceIndex + The position of the network interface in the attachment order. A primary network interface has a device index of 0. +If you specify a network interface when launching an instance, you must specify the device index. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex PrimitiveType: Integer UpdateType: Mutable .PARAMETER Groups + The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups DuplicatesAllowed: False PrimitiveItemType: String @@ -38,11 +49,15 @@ function Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification { UpdateType: Mutable .PARAMETER Ipv6AddressCount + A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount PrimitiveType: Integer UpdateType: Mutable .PARAMETER Ipv6Addresses + One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses DuplicatesAllowed: False ItemType: InstanceIpv6Address @@ -50,11 +65,15 @@ function Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification { UpdateType: Mutable .PARAMETER NetworkInterfaceId + The ID of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateIpAddresses + One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses DuplicatesAllowed: False ItemType: PrivateIpAddressSpecification @@ -62,11 +81,15 @@ function Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification { UpdateType: Mutable .PARAMETER SecondaryPrivateIpAddressCount + The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount PrimitiveType: Integer UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateConfig.ps1 index c39a1c947..4be9b1288 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2SpotFleetLaunchTemplateConfig { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.LaunchTemplateConfig resource property to the template. + Adds an AWS::EC2::SpotFleet.LaunchTemplateConfig resource property to the template. Specifies a launch template and overrides. .DESCRIPTION Adds an AWS::EC2::SpotFleet.LaunchTemplateConfig resource property to the template. - +Specifies a launch template and overrides. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html .PARAMETER LaunchTemplateSpecification + The launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-launchtemplatespecification Type: FleetLaunchTemplateSpecification UpdateType: Mutable .PARAMETER Overrides + Any parameters that you specify override the same parameters in the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-overrides DuplicatesAllowed: False ItemType: LaunchTemplateOverrides diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateOverrides.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateOverrides.ps1 index 78ee7f1f2..fd1eba512 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateOverrides.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLaunchTemplateOverrides.ps1 @@ -1,36 +1,46 @@ function Add-VSEC2SpotFleetLaunchTemplateOverrides { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.LaunchTemplateOverrides resource property to the template. + Adds an AWS::EC2::SpotFleet.LaunchTemplateOverrides resource property to the template. Specifies overrides for a launch template. .DESCRIPTION Adds an AWS::EC2::SpotFleet.LaunchTemplateOverrides resource property to the template. - +Specifies overrides for a launch template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html .PARAMETER AvailabilityZone + The Availability Zone in which to launch the instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER SpotPrice + The maximum price per unit hour that you are willing to pay for a Spot Instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-spotprice PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet in which to launch the instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-subnetid PrimitiveType: String UpdateType: Mutable .PARAMETER WeightedCapacity + The number of units provided by the specified instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-weightedcapacity PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLoadBalancersConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLoadBalancersConfig.ps1 index b839fe0be..1967e7742 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLoadBalancersConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetLoadBalancersConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2SpotFleetLoadBalancersConfig { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.LoadBalancersConfig resource property to the template. + Adds an AWS::EC2::SpotFleet.LoadBalancersConfig resource property to the template. Specifies the Classic Load Balancers and target groups to attach to a Spot Fleet request. .DESCRIPTION Adds an AWS::EC2::SpotFleet.LoadBalancersConfig resource property to the template. - +Specifies the Classic Load Balancers and target groups to attach to a Spot Fleet request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html .PARAMETER ClassicLoadBalancersConfig + The Classic Load Balancers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-classicloadbalancersconfig Type: ClassicLoadBalancersConfig UpdateType: Mutable .PARAMETER TargetGroupsConfig + The target groups. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-targetgroupsconfig Type: TargetGroupsConfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetPrivateIpAddressSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetPrivateIpAddressSpecification.ps1 index fda2f78a4..bcb5bafbd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetPrivateIpAddressSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetPrivateIpAddressSpecification.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2SpotFleetPrivateIpAddressSpecification { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.PrivateIpAddressSpecification resource property to the template. + Adds an AWS::EC2::SpotFleet.PrivateIpAddressSpecification resource property to the template. Describes a secondary private IPv4 address for a network interface. .DESCRIPTION Adds an AWS::EC2::SpotFleet.PrivateIpAddressSpecification resource property to the template. - +Describes a secondary private IPv4 address for a network interface. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html .PARAMETER Primary + Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html#cfn-ec2-spotfleet-privateipaddressspecification-primary PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PrivateIpAddress + The private IPv4 addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html#cfn-ec2-spotfleet-privateipaddressspecification-privateipaddress PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 index 4d82c6bf6..a87254fa0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetSpotFleetLaunchSpecification { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.SpotFleetLaunchSpecification resource property to the template. + Adds an AWS::EC2::SpotFleet.SpotFleetLaunchSpecification resource property to the template. Specifies the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html. .DESCRIPTION Adds an AWS::EC2::SpotFleet.SpotFleetLaunchSpecification resource property to the template. - +Specifies the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html .PARAMETER BlockDeviceMappings + One or more block devices that are mapped to the Spot instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings DuplicatesAllowed: False ItemType: BlockDeviceMapping @@ -18,41 +20,58 @@ function Add-VSEC2SpotFleetSpotFleetLaunchSpecification { UpdateType: Mutable .PARAMETER EbsOptimized + Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ebsoptimized PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IamInstanceProfile + The IAM instance profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-iaminstanceprofile Type: IamInstanceProfileSpecification UpdateType: Mutable .PARAMETER ImageId + The ID of the AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-imageid PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER KernelId + The ID of the kernel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-kernelid PrimitiveType: String UpdateType: Mutable .PARAMETER KeyName + The name of the key pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-keyname PrimitiveType: String UpdateType: Mutable .PARAMETER Monitoring + Enable or disable monitoring for the instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-monitoring Type: SpotFleetMonitoring UpdateType: Mutable .PARAMETER NetworkInterfaces + One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-networkinterfaces DuplicatesAllowed: False ItemType: InstanceNetworkInterfaceSpecification @@ -60,16 +79,22 @@ function Add-VSEC2SpotFleetSpotFleetLaunchSpecification { UpdateType: Mutable .PARAMETER Placement + The placement information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-placement Type: SpotPlacement UpdateType: Mutable .PARAMETER RamdiskId + The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ramdiskid PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroups + One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-securitygroups DuplicatesAllowed: False ItemType: GroupIdentifier @@ -77,16 +102,22 @@ function Add-VSEC2SpotFleetSpotFleetLaunchSpecification { UpdateType: Mutable .PARAMETER SpotPrice + The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-spotprice PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid PrimitiveType: String UpdateType: Mutable .PARAMETER TagSpecifications + The tags to apply during creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-tagspecifications DuplicatesAllowed: False ItemType: SpotFleetTagSpecification @@ -94,11 +125,16 @@ function Add-VSEC2SpotFleetSpotFleetLaunchSpecification { UpdateType: Mutable .PARAMETER UserData + The Base64-encoded user data that instances use when starting up. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-userdata PrimitiveType: String UpdateType: Mutable .PARAMETER WeightedCapacity + The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. +If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-weightedcapacity PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetMonitoring.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetMonitoring.ps1 index 14f09edc1..81be08373 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetMonitoring.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetMonitoring.ps1 @@ -1,16 +1,19 @@ function Add-VSEC2SpotFleetSpotFleetMonitoring { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.SpotFleetMonitoring resource property to the template. + Adds an AWS::EC2::SpotFleet.SpotFleetMonitoring resource property to the template. Describes whether monitoring is enabled. .DESCRIPTION Adds an AWS::EC2::SpotFleet.SpotFleetMonitoring resource property to the template. - +Describes whether monitoring is enabled. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-monitoring.html .PARAMETER Enabled + Enables monitoring for the instance. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-monitoring.html#cfn-ec2-spotfleet-spotfleetmonitoring-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 index 830af33c6..af641e303 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 @@ -1,36 +1,48 @@ function Add-VSEC2SpotFleetSpotFleetRequestConfigData { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.SpotFleetRequestConfigData resource property to the template. + Adds an AWS::EC2::SpotFleet.SpotFleetRequestConfigData resource property to the template. Specifies the configuration of a Spot Fleet request. For more information, see How Spot Fleet Works: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html in the *Amazon EC2 User Guide for Linux Instances*. .DESCRIPTION Adds an AWS::EC2::SpotFleet.SpotFleetRequestConfigData resource property to the template. +Specifies the configuration of a Spot Fleet request. For more information, see How Spot Fleet Works: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html in the *Amazon EC2 User Guide for Linux Instances*. +You must specify either LaunchSpecifications or LaunchTemplateConfigs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html .PARAMETER AllocationStrategy + Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy PrimitiveType: String UpdateType: Immutable .PARAMETER ExcessCapacityTerminationPolicy + Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-excesscapacityterminationpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER IamFleetRole + The Amazon Resource Name ARN of an AWS Identity and Access Management IAM role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites in the *Amazon EC2 User Guide for Linux Instances*. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceInterruptionBehavior + The behavior when a Spot Instance is interrupted. The default is terminate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instanceinterruptionbehavior PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchSpecifications + The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications DuplicatesAllowed: False ItemType: SpotFleetLaunchSpecification @@ -38,6 +50,8 @@ function Add-VSEC2SpotFleetSpotFleetRequestConfigData { UpdateType: Immutable .PARAMETER LaunchTemplateConfigs + The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchtemplateconfigs DuplicatesAllowed: False ItemType: LaunchTemplateConfig @@ -45,26 +59,37 @@ function Add-VSEC2SpotFleetSpotFleetRequestConfigData { UpdateType: Immutable .PARAMETER LoadBalancersConfig + One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups. +With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-loadbalancersconfig Type: LoadBalancersConfig UpdateType: Immutable .PARAMETER ReplaceUnhealthyInstances + Indicates whether Spot Fleet should replace unhealthy instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-replaceunhealthyinstances PrimitiveType: Boolean UpdateType: Immutable .PARAMETER SpotPrice + The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotprice PrimitiveType: String UpdateType: Immutable .PARAMETER TargetCapacity + The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER TerminateInstancesWithExpiration + Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-terminateinstanceswithexpiration PrimitiveType: Boolean UpdateType: Immutable @@ -75,11 +100,15 @@ function Add-VSEC2SpotFleetSpotFleetRequestConfigData { UpdateType: Immutable .PARAMETER ValidFrom + The start date and time of the request, in UTC format *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z. By default, Amazon EC2 starts fulfilling the request immediately. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validfrom PrimitiveType: String UpdateType: Immutable .PARAMETER ValidUntil + The end date and time of the request, in UTC format *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z. After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validuntil PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 index f897662fd..2995d6f90 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2SpotFleetSpotFleetTagSpecification { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.SpotFleetTagSpecification resource property to the template. + Adds an AWS::EC2::SpotFleet.SpotFleetTagSpecification resource property to the template. The tags for a Spot Fleet resource. .DESCRIPTION Adds an AWS::EC2::SpotFleet.SpotFleetTagSpecification resource property to the template. - +The tags for a Spot Fleet resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html .PARAMETER ResourceType + The type of resource. Currently, the only resource type that is supported is instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html#cfn-ec2-spotfleet-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotPlacement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotPlacement.ps1 index 7d20a85bf..3431be650 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotPlacement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotPlacement.ps1 @@ -1,26 +1,33 @@ function Add-VSEC2SpotFleetSpotPlacement { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.SpotPlacement resource property to the template. + Adds an AWS::EC2::SpotFleet.SpotPlacement resource property to the template. Describes Spot Instance placement. .DESCRIPTION Adds an AWS::EC2::SpotFleet.SpotPlacement resource property to the template. - +Describes Spot Instance placement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html .PARAMETER AvailabilityZone + The Availability Zone. +To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER GroupName + The name of the placement group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-groupname PrimitiveType: String UpdateType: Mutable .PARAMETER Tenancy + The tenancy of the instance if the instance is running in a VPC. An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-tenancy PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroup.ps1 index f548012bc..f823b597d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroup.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetTargetGroup { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.TargetGroup resource property to the template. + Adds an AWS::EC2::SpotFleet.TargetGroup resource property to the template. Describes a load balancer target group. .DESCRIPTION Adds an AWS::EC2::SpotFleet.TargetGroup resource property to the template. - +Describes a load balancer target group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html .PARAMETER Arn + The Amazon Resource Name ARN of the target group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html#cfn-ec2-spotfleet-targetgroup-arn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroupsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroupsConfig.ps1 index 1050278b5..3728a4499 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroupsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetTargetGroupsConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2SpotFleetTargetGroupsConfig { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet.TargetGroupsConfig resource property to the template. + Adds an AWS::EC2::SpotFleet.TargetGroupsConfig resource property to the template. Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups. .DESCRIPTION Adds an AWS::EC2::SpotFleet.TargetGroupsConfig resource property to the template. - +Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html .PARAMETER TargetGroups + One or more target groups. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html#cfn-ec2-spotfleet-targetgroupsconfig-targetgroups DuplicatesAllowed: False ItemType: TargetGroup diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 index 9429787a9..f65cbc9b6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 @@ -1,21 +1,34 @@ function Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification { <# .SYNOPSIS - Adds an AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification resource property to the template. + Adds an AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification resource property to the template. The tunnel options for a VPN connection. .DESCRIPTION Adds an AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification resource property to the template. - +The tunnel options for a VPN connection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html .PARAMETER PreSharedKey + The pre-shared key PSK to establish initial authentication between the virtual private gateway and customer gateway. +Constraints: Allowed characters are alphanumeric characters and ._. Must be between 8 and 64 characters in length and cannot start with zero 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey PrimitiveType: String UpdateType: Immutable .PARAMETER TunnelInsideCidr + The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. +Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used: ++ 169.254.0.0/30 ++ 169.254.1.0/30 ++ 169.254.2.0/30 ++ 169.254.3.0/30 ++ 169.254.4.0/30 ++ 169.254.5.0/30 ++ 169.254.169.252/30 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsidecidr PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECRRepositoryLifecyclePolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECRRepositoryLifecyclePolicy.ps1 index 9f32de13d..41307a8e4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECRRepositoryLifecyclePolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECRRepositoryLifecyclePolicy.ps1 @@ -1,21 +1,25 @@ function Add-VSECRRepositoryLifecyclePolicy { <# .SYNOPSIS - Adds an AWS::ECR::Repository.LifecyclePolicy resource property to the template. + Adds an AWS::ECR::Repository.LifecyclePolicy resource property to the template. The LifecyclePolicy property type specifies a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html. .DESCRIPTION Adds an AWS::ECR::Repository.LifecyclePolicy resource property to the template. - +The LifecyclePolicy property type specifies a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html .PARAMETER LifecyclePolicyText + The JSON repository policy text to apply to the repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext PrimitiveType: String UpdateType: Mutable .PARAMETER RegistryId + The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceAwsVpcConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceAwsVpcConfiguration.ps1 index f577277ee..1e7976a72 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceAwsVpcConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceAwsVpcConfiguration.ps1 @@ -1,21 +1,26 @@ function Add-VSECSServiceAwsVpcConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::Service.AwsVpcConfiguration resource property to the template. + Adds an AWS::ECS::Service.AwsVpcConfiguration resource property to the template. The AwsVpcConfiguration property specifies an object representing the networking details for a task or service. .DESCRIPTION Adds an AWS::ECS::Service.AwsVpcConfiguration resource property to the template. - +The AwsVpcConfiguration property specifies an object representing the networking details for a task or service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html .PARAMETER AssignPublicIp + Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-assignpublicip PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroups + The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. +All specified security groups must be from the same VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-securitygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +28,9 @@ function Add-VSECSServiceAwsVpcConfiguration { UpdateType: Mutable .PARAMETER Subnets + The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. +All specified subnets must be from the same VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-subnets DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 index 4d9f46771..fba71fa9b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 @@ -1,21 +1,27 @@ function Add-VSECSServiceDeploymentConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. + Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deploymentand the ordering of stopping and starting tasks. .DESCRIPTION Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. - +The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deploymentand the ordering of stopping and starting tasks. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html .PARAMETER MaximumPercent + If a service is using the rolling update ECS deployment type, the **maximum percent** parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks rounded down to the nearest integer, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks provided that the cluster resources required to do this are available. The default value for maximum percent is 200%. +If a service is using the blue/green CODE_DEPLOY or EXTERNAL deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-maximumpercent PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinimumHealthyPercent + If a service is using the rolling update ECS deployment type, the **minimum healthy percent** represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks rounded up to the nearest integer, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that *do not* use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that *do* use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. +If a service is using the blue/green CODE_DEPLOY or EXTERNAL deployment types and tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-minimumhealthypercent PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 index 3d8323921..cfa56ead3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 @@ -1,31 +1,46 @@ function Add-VSECSServiceLoadBalancer { <# .SYNOPSIS - Adds an AWS::ECS::Service.LoadBalancer resource property to the template. + Adds an AWS::ECS::Service.LoadBalancer resource property to the template. The LoadBalancer property specifies details on a load balancer that is used with a service. .DESCRIPTION Adds an AWS::ECS::Service.LoadBalancer resource property to the template. +The LoadBalancer property specifies details on a load balancer that is used with a service. +If the service is using the ECS deployment controller, you are limited to one load balancer or target group. + +If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair. Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it. + +Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html .PARAMETER ContainerName + The name of the container as it appears in a container definition to associate with the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-containername PrimitiveType: String UpdateType: Immutable .PARAMETER ContainerPort + The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-containerport PrimitiveType: Integer UpdateType: Immutable .PARAMETER LoadBalancerName + The name of the load balancer to associate with the Amazon ECS service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-loadbalancername PrimitiveType: String UpdateType: Immutable .PARAMETER TargetGroupArn + The full Amazon Resource Name ARN of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. +If your service's task definition uses the awsvpc network mode which is required for the Fargate launch type, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-targetgrouparn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceNetworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceNetworkConfiguration.ps1 index c54d69d02..87b0397bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceNetworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceNetworkConfiguration.ps1 @@ -1,16 +1,19 @@ function Add-VSECSServiceNetworkConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::Service.NetworkConfiguration resource property to the template. + Adds an AWS::ECS::Service.NetworkConfiguration resource property to the template. The NetworkConfiguration property specifies an object representing the network configuration for a task or service. .DESCRIPTION Adds an AWS::ECS::Service.NetworkConfiguration resource property to the template. - +The NetworkConfiguration property specifies an object representing the network configuration for a task or service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html .PARAMETER AwsvpcConfiguration + The VPC subnets and security groups associated with a task. +All specified subnets and security groups must be from the same VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html#cfn-ecs-service-networkconfiguration-awsvpcconfiguration Type: AwsVpcConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 index 3bdd39312..fb899882d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 @@ -1,21 +1,25 @@ function Add-VSECSServicePlacementConstraint { <# .SYNOPSIS - Adds an AWS::ECS::Service.PlacementConstraint resource property to the template. + Adds an AWS::ECS::Service.PlacementConstraint resource property to the template. The PlacementConstraint property specifies an object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::Service.PlacementConstraint resource property to the template. - +The PlacementConstraint property specifies an object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html .PARAMETER Expression + A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-expression PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementStrategy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementStrategy.ps1 index cb636ec09..dbcc1b9e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementStrategy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementStrategy.ps1 @@ -1,21 +1,25 @@ function Add-VSECSServicePlacementStrategy { <# .SYNOPSIS - Adds an AWS::ECS::Service.PlacementStrategy resource property to the template. + Adds an AWS::ECS::Service.PlacementStrategy resource property to the template. The PlacementStrategy property specifies the task placement strategy for a task or service. For more information, see Task Placement Strategies: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::Service.PlacementStrategy resource property to the template. - +The PlacementStrategy property specifies the task placement strategy for a task or service. For more information, see Task Placement Strategies: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html .PARAMETER Field + The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId or host, which has the same effect, or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-field PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceServiceRegistry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceServiceRegistry.ps1 index ead78a71e..30971e0de 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceServiceRegistry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceServiceRegistry.ps1 @@ -1,31 +1,39 @@ function Add-VSECSServiceServiceRegistry { <# .SYNOPSIS - Adds an AWS::ECS::Service.ServiceRegistry resource property to the template. + Adds an AWS::ECS::Service.ServiceRegistry resource property to the template. The ServiceRegistry property specifies details of the service registry. .DESCRIPTION Adds an AWS::ECS::Service.ServiceRegistry resource property to the template. - +The ServiceRegistry property specifies details of the service registry. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html .PARAMETER ContainerName + The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containername PrimitiveType: String UpdateType: Immutable .PARAMETER ContainerPort + The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containerport PrimitiveType: Integer UpdateType: Immutable .PARAMETER Port + The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-port PrimitiveType: Integer UpdateType: Immutable .PARAMETER RegistryArn + The Amazon Resource Name ARN of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-registryarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 index 86096c494..a3be2a068 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 @@ -1,16 +1,18 @@ function Add-VSECSTaskDefinitionContainerDefinition { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.ContainerDefinition resource property to the template. + Adds an AWS::ECS::TaskDefinition.ContainerDefinition resource property to the template. The ContainerDefinition property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ContainerDefinition resource property to the template. - +The ContainerDefinition property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html .PARAMETER Command + The command that is passed to the container. This parameter maps to Cmd in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the COMMAND parameter to docker run: https://docs.docker.com/engine/reference/run/. For more information, see https://docs.docker.com/engine/reference/builder/#cmd: https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-command DuplicatesAllowed: False PrimitiveItemType: String @@ -18,11 +20,21 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Cpu + The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cpu-shares option to docker run: https://docs.docker.com/engine/reference/run/. +This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value. +You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances: http://aws.amazon.com/ec2/instance-types/ detail page by 1,024. +For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. +Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-cpu PrimitiveType: Integer UpdateType: Immutable .PARAMETER DependsOn + The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. +For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. +This parameter is available for tasks using the Fargate launch type in the Ohio us-east-2 region only and the task or service requires platform version 1.3.0 or later. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dependson DuplicatesAllowed: False ItemType: ContainerDependency @@ -30,11 +42,17 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER DisableNetworking + When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/. +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-disablenetworking PrimitiveType: Boolean UpdateType: Immutable .PARAMETER DnsSearchDomains + A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --dns-search option to docker run: https://docs.docker.com/engine/reference/run/. +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnssearchdomains DuplicatesAllowed: False PrimitiveItemType: String @@ -42,6 +60,9 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER DnsServers + A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --dns option to docker run: https://docs.docker.com/engine/reference/run/. +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnsservers DuplicatesAllowed: False PrimitiveItemType: String @@ -49,6 +70,8 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER DockerLabels + A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --label option to docker run: https://docs.docker.com/engine/reference/run/. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockerlabels DuplicatesAllowed: False PrimitiveItemType: String @@ -56,6 +79,11 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER DockerSecurityOptions + A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type. +This parameter maps to SecurityOpt in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --security-opt option to docker run: https://docs.docker.com/engine/reference/run/. +The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html in the *Amazon Elastic Container Service Developer Guide*. +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockersecurityoptions DuplicatesAllowed: False PrimitiveItemType: String @@ -63,6 +91,9 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER EntryPoint + Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead. +The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --entrypoint option to docker run: https://docs.docker.com/engine/reference/run/. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint: https://docs.docker.com/engine/reference/builder/#entrypoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-entrypoint DuplicatesAllowed: False PrimitiveItemType: String @@ -70,6 +101,9 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Environment + The environment variables to pass to a container. This parameter maps to Env in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --env option to docker run: https://docs.docker.com/engine/reference/run/. +We do not recommend using plaintext environment variables for sensitive information, such as credential data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-environment DuplicatesAllowed: False ItemType: KeyValuePair @@ -77,11 +111,17 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Essential + If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. +All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-essential PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ExtraHosts + A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --add-host option to docker run: https://docs.docker.com/engine/reference/run/. +This parameter is not supported for Windows containers or tasks that use the awsvpc network mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-extrahosts DuplicatesAllowed: False ItemType: HostEntry @@ -89,31 +129,51 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER FirelensConfiguration + *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-firelensconfiguration Type: FirelensConfiguration UpdateType: Immutable .PARAMETER HealthCheck + The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the HEALTHCHECK parameter of docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-healthcheck Type: HealthCheck UpdateType: Immutable .PARAMETER Hostname + The hostname to use for your container. This parameter maps to Hostname in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --hostname option to docker run: https://docs.docker.com/engine/reference/run/. +The hostname parameter is not supported if you are using the awsvpc network mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-hostname PrimitiveType: String UpdateType: Immutable .PARAMETER Image + The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters uppercase and lowercase, numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the IMAGE parameter of docker run: https://docs.docker.com/engine/reference/run/. ++ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks. ++ Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr..amazonaws.com/:latest or 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. ++ Images in official repositories on Docker Hub use a single name for example, ubuntu or mongo. ++ Images in other repositories on Docker Hub are qualified with an organization name for example, amazon/amazon-ecs-agent. ++ Images in other online repositories are qualified further by a domain name for example, quay.io/assemblyline/ubuntu. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-image PrimitiveType: String UpdateType: Immutable .PARAMETER Interactive + When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --interactive option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-interactive PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Links + The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links: https://docs.docker.com/network/links/ in the Docker documentation. This parameter maps to Links in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --link option to docker run: https://docs.docker.com/engine/reference/run/. +This parameter is not supported for Windows containers. +Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-links DuplicatesAllowed: False PrimitiveItemType: String @@ -121,26 +181,50 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER LinuxParameters + Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html. +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-linuxparameters Type: LinuxParameters UpdateType: Immutable .PARAMETER LogConfiguration + The log configuration specification for the container. +If you are using the Fargate launch type, the only supported value is awslogs. +This parameter maps to LogConfig in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --log-driver option to docker run: https://docs.docker.com/engine/reference/run/. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance or on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers: https://docs.docker.com/engine/admin/logging/overview/ in the Docker documentation. +Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon shown in the LogConfiguration: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html data type. Additional log drivers may be available in future releases of the Amazon ECS container agent. +This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' +The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration Type: LogConfiguration UpdateType: Immutable .PARAMETER Memory + The amount in MiB of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --memory option to docker run: https://docs.docker.com/engine/reference/run/. +If using the Fargate launch type, this parameter is optional. +If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used. +The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memory PrimitiveType: Integer UpdateType: Immutable .PARAMETER MemoryReservation + The soft limit in MiB of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter if applicable, or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --memory-reservation option to docker run: https://docs.docker.com/engine/reference/run/. +If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used. +For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. +The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memoryreservation PrimitiveType: Integer UpdateType: Immutable .PARAMETER MountPoints + The mount points for data volumes in your container. +This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --volume option to docker run: https://docs.docker.com/engine/reference/run/. +Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints DuplicatesAllowed: False ItemType: MountPoint @@ -148,11 +232,19 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Name + The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. This parameter maps to name in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --name option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-name PrimitiveType: String UpdateType: Immutable .PARAMETER PortMappings + The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. +For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort. +Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. +This parameter maps to PortBindings in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --publish option to docker run: https://docs.docker.com/engine/reference/run/. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping. +After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html responses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-portmappings DuplicatesAllowed: False ItemType: PortMapping @@ -160,26 +252,38 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Privileged + When this parameter is true, the container is given elevated privileges on the host container instance similar to the root user. This parameter maps to Privileged in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --privileged option to docker run: https://docs.docker.com/engine/reference/run/. +This parameter is not supported for Windows containers or tasks using the Fargate launch type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-privileged PrimitiveType: Boolean UpdateType: Immutable .PARAMETER PseudoTerminal + When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --tty option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-pseudoterminal PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ReadonlyRootFilesystem + When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --read-only option to docker run: https://docs.docker.com/engine/reference/run/. +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-readonlyrootfilesystem PrimitiveType: Boolean UpdateType: Immutable .PARAMETER RepositoryCredentials + The private repository authentication credentials to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-repositorycredentials Type: RepositoryCredentials UpdateType: Immutable .PARAMETER ResourceRequirements + The type and amount of a resource to assign to a container. The only supported resource is a GPU. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-resourcerequirements DuplicatesAllowed: False ItemType: ResourceRequirement @@ -187,6 +291,8 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Secrets + The secrets to pass to the container. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-secrets DuplicatesAllowed: False ItemType: Secret @@ -194,16 +300,26 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER StartTimeout + Time duration in seconds to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state. +For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. +This parameter is available for tasks using the Fargate launch type in the Ohio us-east-2 region only and the task or service requires platform version 1.3.0 or later. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-starttimeout PrimitiveType: Integer UpdateType: Immutable .PARAMETER StopTimeout + Time duration in seconds to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the max stopTimeout value is 2 minutes. This parameter is available for tasks using the Fargate launch type in the Ohio us-east-2 region only and the task or service requires platform version 1.3.0 or later. +For tasks using the EC2 launch type, the stop timeout value for the container takes precedence over the ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used. Container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-stoptimeout PrimitiveType: Integer UpdateType: Immutable .PARAMETER SystemControls + A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --sysctl option to docker run: https://docs.docker.com/engine/reference/run/. +It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-systemcontrols DuplicatesAllowed: False ItemType: SystemControl @@ -211,6 +327,9 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER Ulimits + A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --ulimit option to docker run: https://docs.docker.com/engine/reference/run/. Valid naming values are displayed in the Ulimit: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-ulimits DuplicatesAllowed: False ItemType: Ulimit @@ -218,11 +337,23 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER User + The user name to use inside the container. This parameter maps to User in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --user option to docker run: https://docs.docker.com/engine/reference/run/. +You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer. ++ user ++ user:group ++ uid ++ uid:gid ++ user:gid ++ uid:group +This parameter is not supported for Windows containers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-user PrimitiveType: String UpdateType: Immutable .PARAMETER VolumesFrom + Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --volumes-from option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom DuplicatesAllowed: False ItemType: VolumeFrom @@ -230,6 +361,8 @@ function Add-VSECSTaskDefinitionContainerDefinition { UpdateType: Immutable .PARAMETER WorkingDirectory + The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --workdir option to docker run: https://docs.docker.com/engine/reference/run/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-workingdirectory PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 index 889691253..035571394 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 @@ -1,21 +1,35 @@ function Add-VSECSTaskDefinitionContainerDependency { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.ContainerDependency resource property to the template. + Adds an AWS::ECS::TaskDefinition.ContainerDependency resource property to the template. The ContainerDependency property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ContainerDependency resource property to the template. +The ContainerDependency property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. +Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. + +**Note** + +If you are using tasks that use the Fargate launch type, container dependency parameters are not supported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html .PARAMETER Condition + The dependency condition of the container. The following are the available conditions and their behavior: ++ START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. ++ COMPLETE - This condition validates that a dependent container runs to completion exits before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. ++ SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. ++ HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-condition PrimitiveType: String UpdateType: Immutable .PARAMETER ContainerName + The name of a container. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-containername PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDevice.ps1 index 6cf389b4b..1e29f3341 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDevice.ps1 @@ -1,26 +1,32 @@ function Add-VSECSTaskDefinitionDevice { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.Device resource property to the template. + Adds an AWS::ECS::TaskDefinition.Device resource property to the template. The Device property specifies an object representing a container instance host device. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Device resource property to the template. - +The Device property specifies an object representing a container instance host device. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html .PARAMETER ContainerPath + The path inside the container at which to expose the host device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-containerpath PrimitiveType: String UpdateType: Immutable .PARAMETER HostPath + The path for the device on the host container instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-hostpath PrimitiveType: String UpdateType: Immutable .PARAMETER Permissions + The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-permissions DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 index c5955afbe..5e3635420 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 @@ -1,26 +1,33 @@ function Add-VSECSTaskDefinitionDockerVolumeConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.DockerVolumeConfiguration resource property to the template. + Adds an AWS::ECS::TaskDefinition.DockerVolumeConfiguration resource property to the template. The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.DockerVolumeConfiguration resource property to the template. - +The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html .PARAMETER Autoprovision + If this value is true, the Docker volume is created if it does not already exist. +This field is only used if the scope is shared. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-autoprovision PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Driver + The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery. This parameter maps to Driver in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxdriver option to docker volume create : https://docs.docker.com/engine/reference/commandline/volume_create/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driver PrimitiveType: String UpdateType: Immutable .PARAMETER DriverOpts + A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxopt option to docker volume create : https://docs.docker.com/engine/reference/commandline/volume_create/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driveropts DuplicatesAllowed: False PrimitiveItemType: String @@ -28,6 +35,8 @@ function Add-VSECSTaskDefinitionDockerVolumeConfiguration { UpdateType: Immutable .PARAMETER Labels + Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxlabel option to docker volume create : https://docs.docker.com/engine/reference/commandline/volume_create/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-labels DuplicatesAllowed: False PrimitiveItemType: String @@ -35,6 +44,8 @@ function Add-VSECSTaskDefinitionDockerVolumeConfiguration { UpdateType: Immutable .PARAMETER Scope + The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-scope PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHealthCheck.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHealthCheck.ps1 index 16f003785..66c2492a0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHealthCheck.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHealthCheck.ps1 @@ -1,16 +1,28 @@ function Add-VSECSTaskDefinitionHealthCheck { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.HealthCheck resource property to the template. + Adds an AWS::ECS::TaskDefinition.HealthCheck resource property to the template. The HealthCheck property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.HealthCheck resource property to the template. +The HealthCheck property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile. +The following are notes about container health check support: + ++ Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html. + ++ Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html. + ++ Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html .PARAMETER Command + A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example: + "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] +An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command DuplicatesAllowed: False PrimitiveItemType: String @@ -18,21 +30,30 @@ function Add-VSECSTaskDefinitionHealthCheck { UpdateType: Immutable .PARAMETER Interval + The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-interval PrimitiveType: Integer UpdateType: Immutable .PARAMETER Retries + The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-retries PrimitiveType: Integer UpdateType: Immutable .PARAMETER StartPeriod + The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default. +If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-startperiod PrimitiveType: Integer UpdateType: Immutable .PARAMETER Timeout + The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-timeout PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostEntry.ps1 index 72137a260..f1b11f1a2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSECSTaskDefinitionHostEntry { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.HostEntry resource property to the template. + Adds an AWS::ECS::TaskDefinition.HostEntry resource property to the template. The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.HostEntry resource property to the template. - +The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html .PARAMETER Hostname + The hostname to use in the /etc/hosts entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-hostname PrimitiveType: String UpdateType: Immutable .PARAMETER IpAddress + The IP address to use in the /etc/hosts entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-ipaddress PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostVolumeProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostVolumeProperties.ps1 index 9131ad674..2737b4978 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostVolumeProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionHostVolumeProperties.ps1 @@ -1,16 +1,19 @@ function Add-VSECSTaskDefinitionHostVolumeProperties { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.HostVolumeProperties resource property to the template. + Adds an AWS::ECS::TaskDefinition.HostVolumeProperties resource property to the template. The HostVolumeProperties property specifies details on a container instance bind mount host volume. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.HostVolumeProperties resource property to the template. - +The HostVolumeProperties property specifies details on a container instance bind mount host volume. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html .PARAMETER SourcePath + When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. +If you are using the Fargate launch type, the sourcePath parameter is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html#cfn-ecs-taskdefinition-volumes-host-sourcepath PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKernelCapabilities.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKernelCapabilities.ps1 index 9e9adf1c6..c7b996b8a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKernelCapabilities.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKernelCapabilities.ps1 @@ -1,16 +1,20 @@ function Add-VSECSTaskDefinitionKernelCapabilities { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.KernelCapabilities resource property to the template. + Adds an AWS::ECS::TaskDefinition.KernelCapabilities resource property to the template. The KernelCapabilities property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities in the *Docker run reference*. For more detailed information on these Linux capabilities, see the capabilities(7: http://man7.org/linux/man-pages/man7/capabilities.7.html Linux manual page. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.KernelCapabilities resource property to the template. - +The KernelCapabilities property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities in the *Docker run reference*. For more detailed information on these Linux capabilities, see the capabilities(7: http://man7.org/linux/man-pages/man7/capabilities.7.html Linux manual page. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html .PARAMETER Add + The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cap-add option to docker run: https://docs.docker.com/engine/reference/run/. +If you are using tasks that use the Fargate launch type, the add parameter is not supported. +Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-add DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +22,9 @@ function Add-VSECSTaskDefinitionKernelCapabilities { UpdateType: Immutable .PARAMETER Drop + The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cap-drop option to docker run: https://docs.docker.com/engine/reference/run/. +Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-drop DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKeyValuePair.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKeyValuePair.ps1 index 08291c9aa..518b62a9a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKeyValuePair.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionKeyValuePair.ps1 @@ -1,21 +1,25 @@ function Add-VSECSTaskDefinitionKeyValuePair { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.KeyValuePair resource property to the template. + Adds an AWS::ECS::TaskDefinition.KeyValuePair resource property to the template. The KeyValuePair property specifies a key-value pair object. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.KeyValuePair resource property to the template. - +The KeyValuePair property specifies a key-value pair object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html .PARAMETER Name + The name of the key-value pair. For environment variables, this is the name of the environment variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-name PrimitiveType: String UpdateType: Immutable .PARAMETER Value + The value of the key-value pair. For environment variables, this is the value of the environment variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-value PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 index 158e9231d..6379c2b5b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 @@ -1,21 +1,27 @@ function Add-VSECSTaskDefinitionLinuxParameters { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.LinuxParameters resource property to the template. + Adds an AWS::ECS::TaskDefinition.LinuxParameters resource property to the template. The LinuxParameters property specifies Linux-specific options that are applied to the container, such as Linux KernelCapabilities: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.LinuxParameters resource property to the template. - +The LinuxParameters property specifies Linux-specific options that are applied to the container, such as Linux KernelCapabilities: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html .PARAMETER Capabilities + The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. +If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-capabilities Type: KernelCapabilities UpdateType: Immutable .PARAMETER Devices + Any host devices to expose to the container. This parameter maps to Devices in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --device option to docker run: https://docs.docker.com/engine/reference/run/. +If you are using tasks that use the Fargate launch type, the devices parameter is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-devices DuplicatesAllowed: False ItemType: Device @@ -23,26 +29,38 @@ function Add-VSECSTaskDefinitionLinuxParameters { UpdateType: Immutable .PARAMETER InitProcessEnabled + Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run: https://docs.docker.com/engine/reference/run/. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-initprocessenabled PrimitiveType: Boolean UpdateType: Immutable .PARAMETER MaxSwap + *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-maxswap PrimitiveType: Integer UpdateType: Immutable .PARAMETER SharedMemorySize + The value for the size in MiB of the /dev/shm volume. This parameter maps to the --shm-size option to docker run: https://docs.docker.com/engine/reference/run/. +If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-sharedmemorysize PrimitiveType: Integer UpdateType: Immutable .PARAMETER Swappiness + *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-swappiness PrimitiveType: Integer UpdateType: Immutable .PARAMETER Tmpfs + The container path, mount options, and size in MiB of the tmpfs mount. This parameter maps to the --tmpfs option to docker run: https://docs.docker.com/engine/reference/run/. +If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-tmpfs DuplicatesAllowed: False ItemType: Tmpfs diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 index b97ebdd9b..f1b96412e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 @@ -1,21 +1,30 @@ function Add-VSECSTaskDefinitionLogConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.LogConfiguration resource property to the template. + Adds an AWS::ECS::TaskDefinition.LogConfiguration resource property to the template. The LogConfiguration property specifies log configuration options to send to a custom log driver for the container. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.LogConfiguration resource property to the template. - +The LogConfiguration property specifies log configuration options to send to a custom log driver for the container. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html .PARAMETER LogDriver + The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. +For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk. +For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. +For more information about using the awslogs log driver, see Using the awslogs Log Driver: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html in the *Amazon Elastic Container Service Developer Guide*. +If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub: https://github.com/aws/amazon-ecs-agent and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software. +This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-logdriver PrimitiveType: String UpdateType: Immutable .PARAMETER Options + The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-options DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +32,8 @@ function Add-VSECSTaskDefinitionLogConfiguration { UpdateType: Immutable .PARAMETER SecretOptions + The secrets to pass to the log configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-secretoptions DuplicatesAllowed: False ItemType: Secret diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionMountPoint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionMountPoint.ps1 index 7c69fc68f..512688d08 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionMountPoint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionMountPoint.ps1 @@ -1,26 +1,32 @@ function Add-VSECSTaskDefinitionMountPoint { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.MountPoint resource property to the template. + Adds an AWS::ECS::TaskDefinition.MountPoint resource property to the template. The MountPoint property specifies details on a volume mount point that is used in a container definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.MountPoint resource property to the template. - +The MountPoint property specifies details on a volume mount point that is used in a container definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html .PARAMETER ContainerPath + The path on the container to mount the host volume at. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-containerpath PrimitiveType: String UpdateType: Immutable .PARAMETER ReadOnly + If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-readonly PrimitiveType: Boolean UpdateType: Immutable .PARAMETER SourceVolume + The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-sourcevolume PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionPortMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionPortMapping.ps1 index 09d37a44d..c7add1851 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionPortMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionPortMapping.ps1 @@ -1,26 +1,44 @@ function Add-VSECSTaskDefinitionPortMapping { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.PortMapping resource property to the template. + Adds an AWS::ECS::TaskDefinition.PortMapping resource property to the template. The PortMapping property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.PortMapping resource property to the template. +The PortMapping property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. +If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort. + +After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html API responses. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html .PARAMETER ContainerPort + The port number on the container that is bound to the user-specified or automatically assigned host port. +If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. +If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. +You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-containerport PrimitiveType: Integer UpdateType: Immutable .PARAMETER HostPort + The port number on the container instance to reserve for your container. +If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort. +If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort or set it to 0 while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. +The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. +The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0. +The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-readonly PrimitiveType: Integer UpdateType: Immutable .PARAMETER Protocol + The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-sourcevolume PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionProxyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionProxyConfiguration.ps1 index ded8573f2..2ae509185 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionProxyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionProxyConfiguration.ps1 @@ -1,21 +1,36 @@ function Add-VSECSTaskDefinitionProxyConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.ProxyConfiguration resource property to the template. + Adds an AWS::ECS::TaskDefinition.ProxyConfiguration resource property to the template. The ProxyConfiguration property specifies the details for the App Mesh proxy. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ProxyConfiguration resource property to the template. +The ProxyConfiguration property specifies the details for the App Mesh proxy. +For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. + +For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html .PARAMETER ContainerName + The name of the container that will serve as the App Mesh proxy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-containername PrimitiveType: String UpdateType: Immutable .PARAMETER ProxyConfigurationProperties + The set of network configuration parameters to provide the Container Network Interface CNI plugin, specified as key-value pairs. ++ IgnoredUID - Required The user ID UID of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty. ++ IgnoredGID - Required The group ID GID of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty. ++ AppPorts - Required The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort. ++ ProxyIngressPort - Required Specifies the port that incoming traffic to the AppPorts is directed to. ++ ProxyEgressPort - Required Specifies the port that outgoing traffic from the AppPorts is directed to. ++ EgressIgnoredPorts - Required The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list. ++ EgressIgnoredIPs - Required The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-proxyconfigurationproperties DuplicatesAllowed: False ItemType: KeyValuePair @@ -23,6 +38,8 @@ function Add-VSECSTaskDefinitionProxyConfiguration { UpdateType: Immutable .PARAMETER Type + The proxy type. The only supported value is APPMESH. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionRepositoryCredentials.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionRepositoryCredentials.ps1 index 2fc8d1fdb..51a8bf66d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionRepositoryCredentials.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionRepositoryCredentials.ps1 @@ -1,16 +1,19 @@ function Add-VSECSTaskDefinitionRepositoryCredentials { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.RepositoryCredentials resource property to the template. + Adds an AWS::ECS::TaskDefinition.RepositoryCredentials resource property to the template. The RepositoryCredentials property specifies the repository credentials for private registry authentication. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.RepositoryCredentials resource property to the template. - +The RepositoryCredentials property specifies the repository credentials for private registry authentication. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html .PARAMETER CredentialsParameter + The Amazon Resource Name ARN of the secret containing the private repository credentials. +When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html#cfn-ecs-taskdefinition-repositorycredentials-credentialsparameter PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 index a69aeb147..99d524965 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 @@ -1,21 +1,25 @@ function Add-VSECSTaskDefinitionResourceRequirement { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.ResourceRequirement resource property to the template. + Adds an AWS::ECS::TaskDefinition.ResourceRequirement resource property to the template. The ResourceRequirement property specifies the type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html in the *Amazon Elastic Container Service Developer Guide* .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ResourceRequirement resource property to the template. - +The ResourceRequirement property specifies the type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html in the *Amazon Elastic Container Service Developer Guide* .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html .PARAMETER Type + The type of resource to assign to a container. The only supported value is GPU. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-type PrimitiveType: String UpdateType: Immutable .PARAMETER Value + The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-value PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSecret.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSecret.ps1 index 36f1bd98f..102e6ee83 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSecret.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSecret.ps1 @@ -1,21 +1,26 @@ function Add-VSECSTaskDefinitionSecret { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.Secret resource property to the template. + Adds an AWS::ECS::TaskDefinition.Secret resource property to the template. The Secret property specifies an object representing the secret to expose to your container. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Secret resource property to the template. - +The Secret property specifies an object representing the secret to expose to your container. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html .PARAMETER Name + The name of the secret. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-name PrimitiveType: String UpdateType: Immutable .PARAMETER ValueFrom + The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. +If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-valuefrom PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSystemControl.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSystemControl.ps1 index b9cc4e006..ecdf7e2ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSystemControl.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionSystemControl.ps1 @@ -1,21 +1,31 @@ function Add-VSECSTaskDefinitionSystemControl { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.SystemControl resource property to the template. + Adds an AWS::ECS::TaskDefinition.SystemControl resource property to the template. A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --sysctl option to docker run: https://docs.docker.com/engine/reference/run/. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.SystemControl resource property to the template. +A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --sysctl option to docker run: https://docs.docker.com/engine/reference/run/. +It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons: + ++ For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect. + ++ For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html .PARAMETER Namespace + The namespaced kernel parameter for which to set a value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-namespace PrimitiveType: String UpdateType: Immutable .PARAMETER Value + The value for the namespaced kernel parameter specified in namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-value PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 index 1138c2e0e..81228b057 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 @@ -1,21 +1,29 @@ function Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint resource property to the template. + Adds an AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint resource property to the template. The TaskDefinitionPlacementConstraint property specifies an object representing a constraint on task placement in the task definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint resource property to the template. +The TaskDefinitionPlacementConstraint property specifies an object representing a constraint on task placement in the task definition. +If you are using the Fargate launch type, task placement constraints are not supported. + +For more information, see Task Placement Constraints: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html .PARAMETER Expression + A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-expression PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTmpfs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTmpfs.ps1 index b1675163e..f9e44d91d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTmpfs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTmpfs.ps1 @@ -1,21 +1,26 @@ function Add-VSECSTaskDefinitionTmpfs { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.Tmpfs resource property to the template. + Adds an AWS::ECS::TaskDefinition.Tmpfs resource property to the template. The Tmpfs property specifies the container path, mount options, and size of the tmpfs mount. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Tmpfs resource property to the template. - +The Tmpfs property specifies the container path, mount options, and size of the tmpfs mount. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html .PARAMETER ContainerPath + The absolute file path where the tmpfs volume is to be mounted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-containerpath PrimitiveType: String UpdateType: Immutable .PARAMETER MountOptions + The list of tmpfs volume mount options. +Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-mountoptions DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +28,8 @@ function Add-VSECSTaskDefinitionTmpfs { UpdateType: Immutable .PARAMETER Size + The size in MiB of the tmpfs volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-size PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionUlimit.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionUlimit.ps1 index f42882345..4124b48d3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionUlimit.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionUlimit.ps1 @@ -1,26 +1,32 @@ function Add-VSECSTaskDefinitionUlimit { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.Ulimit resource property to the template. + Adds an AWS::ECS::TaskDefinition.Ulimit resource property to the template. The Ulimit property specifies the ulimit settings to pass to the container. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Ulimit resource property to the template. - +The Ulimit property specifies the ulimit settings to pass to the container. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html .PARAMETER HardLimit + The hard limit for the ulimit type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-hardlimit PrimitiveType: Integer UpdateType: Immutable .PARAMETER Name + The type of the ulimit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-name PrimitiveType: String UpdateType: Immutable .PARAMETER SoftLimit + The soft limit for the ulimit type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-softlimit PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 index cd9d19220..9322c2cd5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 @@ -1,26 +1,33 @@ function Add-VSECSTaskDefinitionVolume { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.Volume resource property to the template. + Adds an AWS::ECS::TaskDefinition.Volume resource property to the template. The Volume property specifies a data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Volume resource property to the template. - +The Volume property specifies a data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html .PARAMETER DockerVolumeConfiguration + This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volume-dockervolumeconfiguration Type: DockerVolumeConfiguration UpdateType: Immutable .PARAMETER Host + This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running. +Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:mypath:C:mypath and D::D:, but not D:mypath:C:mypath or D::C:mypath. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-host Type: HostVolumeProperties UpdateType: Immutable .PARAMETER Name + The name of the volume. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolumeFrom.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolumeFrom.ps1 index 8f6040053..f243fdbb7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolumeFrom.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolumeFrom.ps1 @@ -1,21 +1,25 @@ function Add-VSECSTaskDefinitionVolumeFrom { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.VolumeFrom resource property to the template. + Adds an AWS::ECS::TaskDefinition.VolumeFrom resource property to the template. The VolumeFrom property specifies details on a data volume from another container in the same task definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.VolumeFrom resource property to the template. - +The VolumeFrom property specifies details on a data volume from another container in the same task definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html .PARAMETER ReadOnly + If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-readonly PrimitiveType: Boolean UpdateType: Immutable .PARAMETER SourceContainer + The name of another container within the same task definition from which to mount volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-sourcecontainer PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemElasticFileSystemTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemElasticFileSystemTag.ps1 index 041ae9dea..f52cffb6e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemElasticFileSystemTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemElasticFileSystemTag.ps1 @@ -1,21 +1,25 @@ function Add-VSEFSFileSystemElasticFileSystemTag { <# .SYNOPSIS - Adds an AWS::EFS::FileSystem.ElasticFileSystemTag resource property to the template. + Adds an AWS::EFS::FileSystem.ElasticFileSystemTag resource property to the template. A tag is a key-value pair attached to a file system. Allowed characters in the Key and Value properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : / .DESCRIPTION Adds an AWS::EFS::FileSystem.ElasticFileSystemTag resource property to the template. - +A tag is a key-value pair attached to a file system. Allowed characters in the Key and Value properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : / .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemtags.html .PARAMETER Key + The tag key String. The key can't start with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemtags.html#cfn-efs-filesystem-filesystemtags-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of the tag key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemtags.html#cfn-efs-filesystem-filesystemtags-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEKSClusterResourcesVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEKSClusterResourcesVpcConfig.ps1 index 359c02503..569bcc032 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEKSClusterResourcesVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEKSClusterResourcesVpcConfig.ps1 @@ -1,22 +1,26 @@ function Add-VSEKSClusterResourcesVpcConfig { <# .SYNOPSIS - Adds an AWS::EKS::Cluster.ResourcesVpcConfig resource property to the template. + Adds an AWS::EKS::Cluster.ResourcesVpcConfig resource property to the template. An object representing the VPC configuration to use for an Amazon EKS cluster. .DESCRIPTION Adds an AWS::EKS::Cluster.ResourcesVpcConfig resource property to the template. - +An object representing the VPC configuration to use for an Amazon EKS cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html .PARAMETER SecurityGroupIds + Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-securitygroupids UpdateType: Mutable .PARAMETER SubnetIds + Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-subnetids diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterApplication.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterApplication.ps1 index 2fcf94570..be7d433e9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterApplication.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterApplication.ps1 @@ -1,16 +1,22 @@ function Add-VSEMRClusterApplication { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.Application resource property to the template. + Adds an AWS::EMR::Cluster.Application resource property to the template. Application is a property of AWS::EMR::Cluster. The Application property type defines the open-source big data applications for EMR to install and configure when a cluster is created. .DESCRIPTION Adds an AWS::EMR::Cluster.Application resource property to the template. +Application is a property of AWS::EMR::Cluster. The Application property type defines the open-source big data applications for EMR to install and configure when a cluster is created. +With Amazon EMR release version 4.0 and later, the only accepted parameter is the application Name. To pass arguments to these applications, you use configuration classifications specified using JSON objects in a Configuration property. For more information, see Configuring Applications: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html. + +With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. You can specify the version of the application and arguments to pass to it. Amazon EMR accepts and forwards the argument list to the corresponding installation script as a bootstrap action argument. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html .PARAMETER AdditionalInfo + This option is for advanced users only. This is meta information about clusters and applications that are used for testing and troubleshooting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-additionalinfo DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +24,8 @@ function Add-VSEMRClusterApplication { UpdateType: Mutable .PARAMETER Args + Arguments for Amazon EMR to pass to the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-args DuplicatesAllowed: False PrimitiveItemType: String @@ -25,11 +33,15 @@ function Add-VSEMRClusterApplication { UpdateType: Mutable .PARAMETER Name + The name of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-name PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The version of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterAutoScalingPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterAutoScalingPolicy.ps1 index e2fc75d7b..5ff600ab5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterAutoScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterAutoScalingPolicy.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterAutoScalingPolicy { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.AutoScalingPolicy resource property to the template. + Adds an AWS::EMR::Cluster.AutoScalingPolicy resource property to the template. AutoScalingPolicy is a subproperty of InstanceGroupConfig. AutoScalingPolicy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. For more information, see Using Automatic Scaling in Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html in the *Amazon EMR Management Guide*. .DESCRIPTION Adds an AWS::EMR::Cluster.AutoScalingPolicy resource property to the template. - +AutoScalingPolicy is a subproperty of InstanceGroupConfig. AutoScalingPolicy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. For more information, see Using Automatic Scaling in Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html in the *Amazon EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html .PARAMETER Constraints + The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html#cfn-elasticmapreduce-cluster-autoscalingpolicy-constraints Type: ScalingConstraints UpdateType: Mutable .PARAMETER Rules + The scale-in and scale-out rules that comprise the automatic scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html#cfn-elasticmapreduce-cluster-autoscalingpolicy-rules DuplicatesAllowed: False ItemType: ScalingRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterBootstrapActionConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterBootstrapActionConfig.ps1 index 987903e5f..cdb468e98 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterBootstrapActionConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterBootstrapActionConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterBootstrapActionConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.BootstrapActionConfig resource property to the template. + Adds an AWS::EMR::Cluster.BootstrapActionConfig resource property to the template. BootstrapActionConfig is a property of AWS::EMR::Cluster that can be used to run bootstrap actions on EMR clusters. You can use a bootstrap action to install software and configure EC2 instances for all cluster nodes before EMR installs and configures open-source big data applications on cluster instances. For more information, see Create Bootstrap Actions to Install Additional Software: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-bootstrap.html in the *Amazon EMR Management Guide*. .DESCRIPTION Adds an AWS::EMR::Cluster.BootstrapActionConfig resource property to the template. - +BootstrapActionConfig is a property of AWS::EMR::Cluster that can be used to run bootstrap actions on EMR clusters. You can use a bootstrap action to install software and configure EC2 instances for all cluster nodes before EMR installs and configures open-source big data applications on cluster instances. For more information, see Create Bootstrap Actions to Install Additional Software: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-bootstrap.html in the *Amazon EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html .PARAMETER Name + The name of the bootstrap action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html#cfn-elasticmapreduce-cluster-bootstrapactionconfig-name PrimitiveType: String UpdateType: Mutable .PARAMETER ScriptBootstrapAction + The script run by the bootstrap action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html#cfn-elasticmapreduce-cluster-bootstrapactionconfig-scriptbootstrapaction Type: ScriptBootstrapActionConfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 index 0ab9c7312..41f88215e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterCloudWatchAlarmDefinition { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.CloudWatchAlarmDefinition resource property to the template. + Adds an AWS::EMR::Cluster.CloudWatchAlarmDefinition resource property to the template. CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity. Scaling activity begins when you satisfy the defined alarm conditions. .DESCRIPTION Adds an AWS::EMR::Cluster.CloudWatchAlarmDefinition resource property to the template. - +CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity. Scaling activity begins when you satisfy the defined alarm conditions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html .PARAMETER ComparisonOperator + Determines how the metric specified by MetricName is compared to the value specified by Threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER Dimensions + A CloudWatch metric dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-dimensions DuplicatesAllowed: False ItemType: MetricDimension @@ -23,36 +27,50 @@ function Add-VSEMRClusterCloudWatchAlarmDefinition { UpdateType: Mutable .PARAMETER EvaluationPeriods + The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-evaluationperiods PrimitiveType: Integer UpdateType: Mutable .PARAMETER MetricName + The name of the CloudWatch metric that is watched to determine an alarm condition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER Period + The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes 300 seconds, so if an EMR CloudWatch metric is specified, specify 300. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-period PrimitiveType: Integer UpdateType: Mutable .PARAMETER Statistic + The statistic to apply to the metric associated with the alarm. The default is AVERAGE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Threshold + The value against which the specified statistic is compared. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-threshold PrimitiveType: Double UpdateType: Mutable .PARAMETER Unit + The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterConfiguration.ps1 index d03f3e527..e83855ecd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterConfiguration.ps1 @@ -1,21 +1,29 @@ function Add-VSEMRClusterConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.Configuration resource property to the template. + Adds an AWS::EMR::Cluster.Configuration resource property to the template. **Note** .DESCRIPTION Adds an AWS::EMR::Cluster.Configuration resource property to the template. +**Note** +Used only with Amazon EMR release 4.0 and later. + +Configuration is a subproperty of InstanceFleetConfig or InstanceGroupConfig. Configuration specifies optional configurations for customizing open-source big data applications and environment parameters. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html in the *Amazon EMR Release Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html .PARAMETER Classification + The classification within a configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-classification PrimitiveType: String UpdateType: Mutable .PARAMETER ConfigurationProperties + A list of additional configurations to apply within a configuration object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-configurationproperties DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +31,8 @@ function Add-VSEMRClusterConfiguration { UpdateType: Mutable .PARAMETER Configurations + A list of additional configurations to apply within a configuration object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-configurations DuplicatesAllowed: False ItemType: Configuration diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsBlockDeviceConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsBlockDeviceConfig.ps1 index a444800dd..bed8cb700 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsBlockDeviceConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsBlockDeviceConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterEbsBlockDeviceConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.EbsBlockDeviceConfig resource property to the template. + Adds an AWS::EMR::Cluster.EbsBlockDeviceConfig resource property to the template. EbsBlockDeviceConfig is a subproperty of the EbsConfiguration property type. EbsBlockDeviceConfig defines the number and type of EBS volumes to associate with all EC2 instances in an EMR cluster. .DESCRIPTION Adds an AWS::EMR::Cluster.EbsBlockDeviceConfig resource property to the template. - +EbsBlockDeviceConfig is a subproperty of the EbsConfiguration property type. EbsBlockDeviceConfig defines the number and type of EBS volumes to associate with all EC2 instances in an EMR cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html .PARAMETER VolumeSpecification + EBS volume specifications such as volume type, IOPS, and size GiB that will be requested for the EBS volume attached to an EC2 instance in the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html#cfn-elasticmapreduce-cluster-ebsblockdeviceconfig-volumespecification Type: VolumeSpecification UpdateType: Mutable .PARAMETER VolumesPerInstance + Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html#cfn-elasticmapreduce-cluster-ebsblockdeviceconfig-volumesperinstance PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsConfiguration.ps1 index 5a3449233..60bf14cb1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterEbsConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRClusterEbsConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.EbsConfiguration resource property to the template. + Adds an AWS::EMR::Cluster.EbsConfiguration resource property to the template. EbsConfiguration is a subproperty of InstanceFleetConfig or InstanceGroupConfig. EbsConfiguration determines the EBS volumes to attach to EMR cluster instances. .DESCRIPTION Adds an AWS::EMR::Cluster.EbsConfiguration resource property to the template. - +EbsConfiguration is a subproperty of InstanceFleetConfig or InstanceGroupConfig. EbsConfiguration determines the EBS volumes to attach to EMR cluster instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html .PARAMETER EbsBlockDeviceConfigs + An array of Amazon EBS volume specifications attached to a cluster instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html#cfn-elasticmapreduce-cluster-ebsconfiguration-ebsblockdeviceconfigs DuplicatesAllowed: False ItemType: EbsBlockDeviceConfig @@ -18,6 +20,8 @@ function Add-VSEMRClusterEbsConfiguration { UpdateType: Mutable .PARAMETER EbsOptimized + Indicates whether an Amazon EBS volume is EBS-optimized. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html#cfn-elasticmapreduce-cluster-ebsconfiguration-ebsoptimized PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterHadoopJarStepConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterHadoopJarStepConfig.ps1 index 0b34ec42f..9111b3905 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterHadoopJarStepConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterHadoopJarStepConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRClusterHadoopJarStepConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.HadoopJarStepConfig resource property to the template. + Adds an AWS::EMR::Cluster.HadoopJarStepConfig resource property to the template. The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps. .DESCRIPTION Adds an AWS::EMR::Cluster.HadoopJarStepConfig resource property to the template. - +The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html .PARAMETER Args + A list of command line arguments passed to the JAR file's main function when executed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-args DuplicatesAllowed: False PrimitiveItemType: String @@ -18,16 +20,22 @@ function Add-VSEMRClusterHadoopJarStepConfig { UpdateType: Mutable .PARAMETER Jar + A path to a JAR file run during the step. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-jar PrimitiveType: String UpdateType: Mutable .PARAMETER MainClass + The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-mainclass PrimitiveType: String UpdateType: Mutable .PARAMETER StepProperties + A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-stepproperties DuplicatesAllowed: False ItemType: KeyValue diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetConfig.ps1 index f3d8112b8..4ae8d1a34 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetConfig.ps1 @@ -1,16 +1,22 @@ function Add-VSEMRClusterInstanceFleetConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.InstanceFleetConfig resource property to the template. + Adds an AWS::EMR::Cluster.InstanceFleetConfig resource property to the template. Use InstanceFleetConfig to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see Configure Instance Fleets: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. .DESCRIPTION Adds an AWS::EMR::Cluster.InstanceFleetConfig resource property to the template. +Use InstanceFleetConfig to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see Configure Instance Fleets: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. +**Note** + +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html .PARAMETER InstanceTypeConfigs + The instance type configurations that define the EC2 instances in the instance fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-instancetypeconfigs DuplicatesAllowed: False ItemType: InstanceTypeConfig @@ -18,21 +24,31 @@ function Add-VSEMRClusterInstanceFleetConfig { UpdateType: Immutable .PARAMETER LaunchSpecifications + The launch specification for the instance fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-launchspecifications Type: InstanceFleetProvisioningSpecifications UpdateType: Immutable .PARAMETER Name + The friendly name of the instance fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-name PrimitiveType: String UpdateType: Immutable .PARAMETER TargetOnDemandCapacity + The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. +If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-targetondemandcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER TargetSpotCapacity + The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. +If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-targetspotcapacity PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetProvisioningSpecifications.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetProvisioningSpecifications.ps1 index e8b17ec28..67b91d663 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetProvisioningSpecifications.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceFleetProvisioningSpecifications.ps1 @@ -1,16 +1,22 @@ function Add-VSEMRClusterInstanceFleetProvisioningSpecifications { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications resource property to the template. + Adds an AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications resource property to the template. InstanceFleetProvisioningSpecification is a subproperty of InstanceFleetConfig. InstanceFleetProvisioningSpecification defines the launch specification for Spot instances in an instance fleet, which determines the defined duration and provisioning timeout behavior for Spot instances. .DESCRIPTION Adds an AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications resource property to the template. +InstanceFleetProvisioningSpecification is a subproperty of InstanceFleetConfig. InstanceFleetProvisioningSpecification defines the launch specification for Spot instances in an instance fleet, which determines the defined duration and provisioning timeout behavior for Spot instances. +**Note** + +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetprovisioningspecifications.html .PARAMETER SpotSpecification + The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-cluster-instancefleetprovisioningspecifications-spotspecification Type: SpotProvisioningSpecification UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 index 7afc34b0e..16b1fe115 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 @@ -1,26 +1,34 @@ function Add-VSEMRClusterInstanceGroupConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.InstanceGroupConfig resource property to the template. + Adds an AWS::EMR::Cluster.InstanceGroupConfig resource property to the template. Use InstanceGroupConfig to define instance groups for an EMR cluster. A cluster can not use both instance groups and instance fleets. For more information, see Create a Cluster with Instance Fleets or Uniform Instance Groups: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. .DESCRIPTION Adds an AWS::EMR::Cluster.InstanceGroupConfig resource property to the template. - +Use InstanceGroupConfig to define instance groups for an EMR cluster. A cluster can not use both instance groups and instance fleets. For more information, see Create a Cluster with Instance Fleets or Uniform Instance Groups: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html .PARAMETER AutoScalingPolicy + AutoScalingPolicy is a subproperty of the InstanceGroupConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-jobflowinstancesconfig-instancegroupconfig.html property type that specifies the constraints and rules of an automatic scaling policy in Amazon EMR. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. Only core and task instance groups can use automatic scaling policies. For more information, see Using Automatic Scaling in Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-autoscalingpolicy Type: AutoScalingPolicy UpdateType: Mutable .PARAMETER BidPrice + The maximum Spot price your are willing to pay for EC2 instances. +If BidPrice is specified, Amazon EMR uses Spot Instances for the instance group. Specified in USD. Alternatively, a value of OnDemandPrice indicates that the maximum Spot price is set equal to the On-Demand price. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-bidprice PrimitiveType: String UpdateType: Immutable .PARAMETER Configurations + Amazon EMR releases 4.x or later. +The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group master, core, and task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-configurations DuplicatesAllowed: False ItemType: Configuration @@ -28,26 +36,36 @@ function Add-VSEMRClusterInstanceGroupConfig { UpdateType: Immutable .PARAMETER EbsConfiguration + EBS configurations that will be attached to each EC2 instance in the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-ebsconfiguration Type: EbsConfiguration UpdateType: Immutable .PARAMETER InstanceCount + Target number of instances for the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-instancecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER InstanceType + The EC2 instance type for all instances in the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER Market + Market type of the EC2 instances used to create a cluster node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-market PrimitiveType: String UpdateType: Immutable .PARAMETER Name + Friendly name given to the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceTypeConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceTypeConfig.ps1 index f5cb44edb..a1cadf5fd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceTypeConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceTypeConfig.ps1 @@ -1,26 +1,36 @@ function Add-VSEMRClusterInstanceTypeConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.InstanceTypeConfig resource property to the template. + Adds an AWS::EMR::Cluster.InstanceTypeConfig resource property to the template. **Note** .DESCRIPTION Adds an AWS::EMR::Cluster.InstanceTypeConfig resource property to the template. +**Note** +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + +InstanceTypeConfig is a sub-property of InstanceFleetConfig. InstanceTypeConfig determines the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html .PARAMETER BidPrice + The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-bidprice PrimitiveType: String UpdateType: Immutable .PARAMETER BidPriceAsPercentageOfOnDemandPrice + The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number for example, 20 specifies 20%. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-bidpriceaspercentageofondemandprice PrimitiveType: Double UpdateType: Immutable .PARAMETER Configurations + A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-configurations DuplicatesAllowed: False ItemType: Configuration @@ -28,16 +38,22 @@ function Add-VSEMRClusterInstanceTypeConfig { UpdateType: Immutable .PARAMETER EbsConfiguration + The configuration of Amazon Elastic Block Storage EBS attached to each instance as defined by InstanceType. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-ebsconfiguration Type: EbsConfiguration UpdateType: Immutable .PARAMETER InstanceType + An EC2 instance type, such as m3.xlarge. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER WeightedCapacity + The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-weightedcapacity PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 index 09446461b..9e8c9c062 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRClusterJobFlowInstancesConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.JobFlowInstancesConfig resource property to the template. + Adds an AWS::EMR::Cluster.JobFlowInstancesConfig resource property to the template. JobFlowInstancesConfig is a property of the AWS::EMR::Cluster resource. JobFlowInstancesConfig defines the instance groups or instance fleets that comprise the cluster. JobFlowInstancesConfig must contain either InstanceFleetConfig or InstanceGroupConfig. They cannot be used together. .DESCRIPTION Adds an AWS::EMR::Cluster.JobFlowInstancesConfig resource property to the template. - +JobFlowInstancesConfig is a property of the AWS::EMR::Cluster resource. JobFlowInstancesConfig defines the instance groups or instance fleets that comprise the cluster. JobFlowInstancesConfig must contain either InstanceFleetConfig or InstanceGroupConfig. They cannot be used together. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html .PARAMETER AdditionalMasterSecurityGroups + A list of additional Amazon EC2 security group IDs for the master node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-additionalmastersecuritygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSEMRClusterJobFlowInstancesConfig { UpdateType: Immutable .PARAMETER AdditionalSlaveSecurityGroups + A list of additional Amazon EC2 security group IDs for the core and task nodes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-additionalslavesecuritygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -25,26 +29,38 @@ function Add-VSEMRClusterJobFlowInstancesConfig { UpdateType: Immutable .PARAMETER CoreInstanceFleet + Describes the EC2 instances and instance configurations for the core instance fleet when using clusters with the instance fleet configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-coreinstancefleet Type: InstanceFleetConfig UpdateType: Immutable .PARAMETER CoreInstanceGroup + Describes the EC2 instances and instance configurations for core instance groups when using clusters with the uniform instance group configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-coreinstancegroup Type: InstanceGroupConfig UpdateType: Immutable .PARAMETER Ec2KeyName + The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop." + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2keyname PrimitiveType: String UpdateType: Immutable .PARAMETER Ec2SubnetId + Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches. +Amazon VPC currently does not support cluster compute quadruple extra large cc1.4xlarge instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER Ec2SubnetIds + Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet. +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2subnetids DuplicatesAllowed: False PrimitiveItemType: String @@ -52,46 +68,64 @@ function Add-VSEMRClusterJobFlowInstancesConfig { UpdateType: Immutable .PARAMETER EmrManagedMasterSecurityGroup + The identifier of the Amazon EC2 security group for the master node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-emrmanagedmastersecuritygroup PrimitiveType: String UpdateType: Immutable .PARAMETER EmrManagedSlaveSecurityGroup + The identifier of the Amazon EC2 security group for the core and task nodes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-emrmanagedslavesecuritygroup PrimitiveType: String UpdateType: Immutable .PARAMETER HadoopVersion + Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" deprecated, "0.20" deprecated, "0.20.205" deprecated, "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-hadoopversion PrimitiveType: String UpdateType: Immutable .PARAMETER KeepJobFlowAliveWhenNoSteps + Specifies whether the cluster should remain available after completing all steps. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-keepjobflowalivewhennosteps PrimitiveType: Boolean UpdateType: Immutable .PARAMETER MasterInstanceFleet + Describes the EC2 instances and instance configurations for the master instance fleet when using clusters with the instance fleet configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-masterinstancefleet Type: InstanceFleetConfig UpdateType: Immutable .PARAMETER MasterInstanceGroup + Describes the EC2 instances and instance configurations for the master instance group when using clusters with the uniform instance group configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-masterinstancegroup Type: InstanceGroupConfig UpdateType: Immutable .PARAMETER Placement + The Availability Zone in which the cluster runs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-placement Type: PlacementType UpdateType: Immutable .PARAMETER ServiceAccessSecurityGroup + The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-serviceaccesssecuritygroup PrimitiveType: String UpdateType: Immutable .PARAMETER TerminationProtected + Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-terminationprotected PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKerberosAttributes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKerberosAttributes.ps1 index 2f8485009..ff90fcd0f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKerberosAttributes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKerberosAttributes.ps1 @@ -1,36 +1,46 @@ function Add-VSEMRClusterKerberosAttributes { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.KerberosAttributes resource property to the template. + Adds an AWS::EMR::Cluster.KerberosAttributes resource property to the template. KerberosAttributes is a property of the AWS::EMR::Cluster resource. KerberosAttributes define the cluster-specific Kerberos configuration when Kerberos authentication is enabled using a security configuration. The cluster-specific configuration must be compatible with the security configuration. For more information see Use Kerberos Authentication: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html in the *EMR Management Guide*. .DESCRIPTION Adds an AWS::EMR::Cluster.KerberosAttributes resource property to the template. - +KerberosAttributes is a property of the AWS::EMR::Cluster resource. KerberosAttributes define the cluster-specific Kerberos configuration when Kerberos authentication is enabled using a security configuration. The cluster-specific configuration must be compatible with the security configuration. For more information see Use Kerberos Authentication: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html in the *EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html .PARAMETER ADDomainJoinPassword + The Active Directory password for ADDomainJoinUser. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-addomainjoinpassword PrimitiveType: String UpdateType: Mutable .PARAMETER ADDomainJoinUser + Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-addomainjoinuser PrimitiveType: String UpdateType: Mutable .PARAMETER CrossRealmTrustPrincipalPassword + Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-crossrealmtrustprincipalpassword PrimitiveType: String UpdateType: Mutable .PARAMETER KdcAdminPassword + The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-kdcadminpassword PrimitiveType: String UpdateType: Mutable .PARAMETER Realm + The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-realm PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKeyValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKeyValue.ps1 index 99aab8577..c5738ee5a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKeyValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterKeyValue.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterKeyValue { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.KeyValue resource property to the template. + Adds an AWS::EMR::Cluster.KeyValue resource property to the template. KeyValue is a subproperty of the HadoopJarStepConfig property type. KeyValue is used to pass parameters to a step. .DESCRIPTION Adds an AWS::EMR::Cluster.KeyValue resource property to the template. - +KeyValue is a subproperty of the HadoopJarStepConfig property type. KeyValue is used to pass parameters to a step. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-keyvalue.html .PARAMETER Key + The unique identifier of a key value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-keyvalue.html#cfn-elasticmapreduce-cluster-keyvalue-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value part of the identified key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-keyvalue.html#cfn-elasticmapreduce-cluster-keyvalue-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterMetricDimension.ps1 index 9c174d0a9..7ac2d25ba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterMetricDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterMetricDimension { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.MetricDimension resource property to the template. + Adds an AWS::EMR::Cluster.MetricDimension resource property to the template. MetricDimension is a subproperty of the CloudWatchAlarmDefinition property type. MetricDimension specifies a CloudWatch dimension, which is specified with a Key Value pair. The key is known as a Name in CloudWatch. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the automatic scaling rule for EMR to bootstrap when the cluster ID becomes available during cluster creation. .DESCRIPTION Adds an AWS::EMR::Cluster.MetricDimension resource property to the template. - +MetricDimension is a subproperty of the CloudWatchAlarmDefinition property type. MetricDimension specifies a CloudWatch dimension, which is specified with a Key Value pair. The key is known as a Name in CloudWatch. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the automatic scaling rule for EMR to bootstrap when the cluster ID becomes available during cluster creation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html .PARAMETER Key + The dimension name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html#cfn-elasticmapreduce-cluster-metricdimension-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The dimension value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html#cfn-elasticmapreduce-cluster-metricdimension-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterPlacementType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterPlacementType.ps1 index fba4325b9..ee51c853b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterPlacementType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterPlacementType.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRClusterPlacementType { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.PlacementType resource property to the template. + Adds an AWS::EMR::Cluster.PlacementType resource property to the template. PlacementType is a property of the AWS::EMR::Cluster resource. PlacementType determines the Amazon EC2 Availability Zone configuration of the cluster (job flow. .DESCRIPTION Adds an AWS::EMR::Cluster.PlacementType resource property to the template. - +PlacementType is a property of the AWS::EMR::Cluster resource. PlacementType determines the Amazon EC2 Availability Zone configuration of the cluster (job flow. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementtype.html .PARAMETER AvailabilityZone + The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones plural is used for instance fleets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementtype.html#cfn-elasticmapreduce-cluster-placementtype-availabilityzone PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingAction.ps1 index 11ea01278..1aabd1362 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingAction.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterScalingAction { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.ScalingAction resource property to the template. + Adds an AWS::EMR::Cluster.ScalingAction resource property to the template. ScalingAction is a subproperty of the ScalingRule property type. ScalingAction determines the type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. .DESCRIPTION Adds an AWS::EMR::Cluster.ScalingAction resource property to the template. - +ScalingAction is a subproperty of the ScalingRule property type. ScalingAction determines the type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html .PARAMETER Market + Not available for instance groups. Instance groups use the market type specified for the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html#cfn-elasticmapreduce-cluster-scalingaction-market PrimitiveType: String UpdateType: Mutable .PARAMETER SimpleScalingPolicyConfiguration + The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html#cfn-elasticmapreduce-cluster-scalingaction-simplescalingpolicyconfiguration Type: SimpleScalingPolicyConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingConstraints.ps1 index 7fc7fd78d..8755f6f7c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingConstraints.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRClusterScalingConstraints { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.ScalingConstraints resource property to the template. + Adds an AWS::EMR::Cluster.ScalingConstraints resource property to the template. ScalingConstraints is a subproperty of the AutoScalingPolicy property type. ScalingConstraints defines the upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or shrink below these limits. .DESCRIPTION Adds an AWS::EMR::Cluster.ScalingConstraints resource property to the template. - +ScalingConstraints is a subproperty of the AutoScalingPolicy property type. ScalingConstraints defines the upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or shrink below these limits. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html .PARAMETER MaxCapacity + The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html#cfn-elasticmapreduce-cluster-scalingconstraints-maxcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinCapacity + The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html#cfn-elasticmapreduce-cluster-scalingconstraints-mincapacity PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingRule.ps1 index f98376828..d4feea181 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingRule.ps1 @@ -1,31 +1,39 @@ function Add-VSEMRClusterScalingRule { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.ScalingRule resource property to the template. + Adds an AWS::EMR::Cluster.ScalingRule resource property to the template. ScalingRule is a subproperty of the AutoScalingPolicy property type. ScalingRule defines the scale-in or scale-out rules for scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules. .DESCRIPTION Adds an AWS::EMR::Cluster.ScalingRule resource property to the template. - +ScalingRule is a subproperty of the AutoScalingPolicy property type. ScalingRule defines the scale-in or scale-out rules for scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html .PARAMETER Action + The conditions that trigger an automatic scaling activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-action Type: ScalingAction UpdateType: Mutable .PARAMETER Description + A friendly, more verbose description of the automatic scaling rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-description PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-name PrimitiveType: String UpdateType: Mutable .PARAMETER Trigger + The CloudWatch alarm definition that determines when automatic scaling activity is triggered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-trigger Type: ScalingTrigger UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingTrigger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingTrigger.ps1 index 93a92013b..3fb2cc050 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingTrigger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScalingTrigger.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRClusterScalingTrigger { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.ScalingTrigger resource property to the template. + Adds an AWS::EMR::Cluster.ScalingTrigger resource property to the template. ScalingTrigger is a subproperty of the ScalingRule property type. ScalingTrigger determines the conditions that trigger an automatic scaling activity. .DESCRIPTION Adds an AWS::EMR::Cluster.ScalingTrigger resource property to the template. - +ScalingTrigger is a subproperty of the ScalingRule property type. ScalingTrigger determines the conditions that trigger an automatic scaling activity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingtrigger.html .PARAMETER CloudWatchAlarmDefinition + The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingtrigger.html#cfn-elasticmapreduce-cluster-scalingtrigger-cloudwatchalarmdefinition Type: CloudWatchAlarmDefinition UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScriptBootstrapActionConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScriptBootstrapActionConfig.ps1 index 1f78c0f13..9df381a69 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScriptBootstrapActionConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterScriptBootstrapActionConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRClusterScriptBootstrapActionConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.ScriptBootstrapActionConfig resource property to the template. + Adds an AWS::EMR::Cluster.ScriptBootstrapActionConfig resource property to the template. ScriptBootstrapActionConfig is a subproperty of the BootstrapActionConfig property type. ScriptBootstrapActionConfig specifies the arguments and location of the bootstrap script for EMR to run on all cluster nodes before it installs open-source big data applications on them. .DESCRIPTION Adds an AWS::EMR::Cluster.ScriptBootstrapActionConfig resource property to the template. - +ScriptBootstrapActionConfig is a subproperty of the BootstrapActionConfig property type. ScriptBootstrapActionConfig specifies the arguments and location of the bootstrap script for EMR to run on all cluster nodes before it installs open-source big data applications on them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html .PARAMETER Args + A list of command line arguments to pass to the bootstrap action script. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html#cfn-elasticmapreduce-cluster-scriptbootstrapactionconfig-args DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSEMRClusterScriptBootstrapActionConfig { UpdateType: Mutable .PARAMETER Path + Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html#cfn-elasticmapreduce-cluster-scriptbootstrapactionconfig-path PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSimpleScalingPolicyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSimpleScalingPolicyConfiguration.ps1 index 6ff6ae0ee..e4e25f044 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSimpleScalingPolicyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSimpleScalingPolicyConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSEMRClusterSimpleScalingPolicyConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.SimpleScalingPolicyConfiguration resource property to the template. + Adds an AWS::EMR::Cluster.SimpleScalingPolicyConfiguration resource property to the template. SimpleScalingPolicyConfiguration is a subproperty of the ScalingAction property type. SimpleScalingPolicyConfiguration determines how an automatic scaling action adds or removes instances, the cooldown period, and the number of EC2 instances that are added each time the CloudWatch metric alarm condition is satisfied. .DESCRIPTION Adds an AWS::EMR::Cluster.SimpleScalingPolicyConfiguration resource property to the template. - +SimpleScalingPolicyConfiguration is a subproperty of the ScalingAction property type. SimpleScalingPolicyConfiguration determines how an automatic scaling action adds or removes instances, the cooldown period, and the number of EC2 instances that are added each time the CloudWatch metric alarm condition is satisfied. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html .PARAMETER AdjustmentType + The way in which EC2 instances are added if ScalingAdjustment is a positive number or terminated if ScalingAdjustment is a negative number each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-adjustmenttype PrimitiveType: String UpdateType: Mutable .PARAMETER CoolDown + The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-cooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER ScalingAdjustment + The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-scalingadjustment PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSpotProvisioningSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSpotProvisioningSpecification.ps1 index 260cdb163..1d1c2a982 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSpotProvisioningSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterSpotProvisioningSpecification.ps1 @@ -1,26 +1,36 @@ function Add-VSEMRClusterSpotProvisioningSpecification { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.SpotProvisioningSpecification resource property to the template. + Adds an AWS::EMR::Cluster.SpotProvisioningSpecification resource property to the template. SpotProvisioningSpecification is a subproperty of the InstanceFleetProvisioningSpecifications property type. SpotProvisioningSpecification determines the launch specification for Spot instances in the instance fleet, which includes the defined duration and provisioning timeout behavior. .DESCRIPTION Adds an AWS::EMR::Cluster.SpotProvisioningSpecification resource property to the template. +SpotProvisioningSpecification is a subproperty of the InstanceFleetProvisioningSpecifications property type. SpotProvisioningSpecification determines the launch specification for Spot instances in the instance fleet, which includes the defined duration and provisioning timeout behavior. +**Note** + +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html .PARAMETER BlockDurationMinutes + The defined duration for Spot instances also known as Spot blocks in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-blockdurationminutes PrimitiveType: Integer UpdateType: Mutable .PARAMETER TimeoutAction + The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-timeoutaction PrimitiveType: String UpdateType: Mutable .PARAMETER TimeoutDurationMinutes + The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-timeoutdurationminutes PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 index 398f5b906..31abf843e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSEMRClusterStepConfig { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.StepConfig resource property to the template. + Adds an AWS::EMR::Cluster.StepConfig resource property to the template. StepConfig is a property of the AWS::EMR::Cluster resource. The StepConfig property type specifies a cluster (job flow step, which runs only on the master node. Steps are used to submit data processing jobs to the cluster. .DESCRIPTION Adds an AWS::EMR::Cluster.StepConfig resource property to the template. - +StepConfig is a property of the AWS::EMR::Cluster resource. The StepConfig property type specifies a cluster (job flow step, which runs only on the master node. Steps are used to submit data processing jobs to the cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html .PARAMETER ActionOnFailure + The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-actiononfailure PrimitiveType: String UpdateType: Mutable .PARAMETER HadoopJarStep + The JAR file used for the step. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-hadoopjarstep Type: HadoopJarStepConfig UpdateType: Mutable .PARAMETER Name + The name of the step. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterVolumeSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterVolumeSpecification.ps1 index d360a5776..b191d42d5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterVolumeSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterVolumeSpecification.ps1 @@ -1,26 +1,32 @@ function Add-VSEMRClusterVolumeSpecification { <# .SYNOPSIS - Adds an AWS::EMR::Cluster.VolumeSpecification resource property to the template. + Adds an AWS::EMR::Cluster.VolumeSpecification resource property to the template. VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type. VolumeSecification determines the volume type, IOPS, and size (GiB for EBS volumes attached to EC2 instances. .DESCRIPTION Adds an AWS::EMR::Cluster.VolumeSpecification resource property to the template. - +VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type. VolumeSecification determines the volume type, IOPS, and size (GiB for EBS volumes attached to EC2 instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER SizeInGB + The volume size, in gibibytes GiB. This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-sizeingb PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type. Volume types supported are gp2, io1, standard. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigConfiguration.ps1 index c0cb24787..abe9cd5fe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigConfiguration.ps1 @@ -1,21 +1,29 @@ function Add-VSEMRInstanceFleetConfigConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.Configuration resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.Configuration resource property to the template. **Note** .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.Configuration resource property to the template. +**Note** +Used only with Amazon EMR release 4.0 and later. + +Configuration specifies optional configurations for customizing open-source big data applications and environment parameters. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html in the *Amazon EMR Release Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html .PARAMETER Classification + The classification within a configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-classification PrimitiveType: String UpdateType: Immutable .PARAMETER ConfigurationProperties + Within a configuration classification, a set of properties that represent the settings that you want to change in the configuration file. Duplicates not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-configurationproperties DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +31,8 @@ function Add-VSEMRInstanceFleetConfigConfiguration { UpdateType: Immutable .PARAMETER Configurations + A list of additional configurations to apply within a configuration object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-configurations DuplicatesAllowed: False ItemType: Configuration diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsBlockDeviceConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsBlockDeviceConfig.ps1 index 7d31e76f1..ee553fee5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsBlockDeviceConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsBlockDeviceConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceFleetConfigEbsBlockDeviceConfig { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig resource property to the template. EbsBlockDeviceConfig is a subproperty of the EbsConfiguration property type. EbsBlockDeviceConfig defines the number and type of EBS volumes to associate with all EC2 instances in an EMR cluster. .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig resource property to the template. - +EbsBlockDeviceConfig is a subproperty of the EbsConfiguration property type. EbsBlockDeviceConfig defines the number and type of EBS volumes to associate with all EC2 instances in an EMR cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html .PARAMETER VolumeSpecification + EBS volume specifications such as volume type, IOPS, and size GiB that will be requested for the EBS volume attached to an EC2 instance in the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html#cfn-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig-volumespecification Type: VolumeSpecification UpdateType: Immutable .PARAMETER VolumesPerInstance + Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html#cfn-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig-volumesperinstance PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsConfiguration.ps1 index 227a95d3e..0226559b1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigEbsConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRInstanceFleetConfigEbsConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.EbsConfiguration resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.EbsConfiguration resource property to the template. EbsConfiguration determines the EBS volumes to attach to EMR cluster instances. .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.EbsConfiguration resource property to the template. - +EbsConfiguration determines the EBS volumes to attach to EMR cluster instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html .PARAMETER EbsBlockDeviceConfigs + An array of Amazon EBS volume specifications attached to a cluster instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html#cfn-elasticmapreduce-instancefleetconfig-ebsconfiguration-ebsblockdeviceconfigs DuplicatesAllowed: False ItemType: EbsBlockDeviceConfig @@ -18,6 +20,8 @@ function Add-VSEMRInstanceFleetConfigEbsConfiguration { UpdateType: Immutable .PARAMETER EbsOptimized + Indicates whether an Amazon EBS volume is EBS-optimized. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html#cfn-elasticmapreduce-instancefleetconfig-ebsconfiguration-ebsoptimized PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceFleetProvisioningSpecifications.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceFleetProvisioningSpecifications.ps1 index 58bfb4b59..303f1a4e9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceFleetProvisioningSpecifications.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceFleetProvisioningSpecifications.ps1 @@ -1,16 +1,22 @@ function Add-VSEMRInstanceFleetConfigInstanceFleetProvisioningSpecifications { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications resource property to the template. **Note** .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications resource property to the template. +**Note** +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + +InstanceTypeConfig is a sub-property of InstanceFleetConfig. InstanceTypeConfig determines the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html .PARAMETER SpotSpecification + The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications-spotspecification Type: SpotProvisioningSpecification UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceTypeConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceTypeConfig.ps1 index ab9018617..f66d8b2ff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceTypeConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigInstanceTypeConfig.ps1 @@ -1,26 +1,37 @@ function Add-VSEMRInstanceFleetConfigInstanceTypeConfig { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.InstanceTypeConfig resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.InstanceTypeConfig resource property to the template. InstanceType config is a subproperty of InstanceFleetConfig. An instance type configuration specifies each instance type in an instance fleet. The configuration determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet. .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.InstanceTypeConfig resource property to the template. +InstanceType config is a subproperty of InstanceFleetConfig. An instance type configuration specifies each instance type in an instance fleet. The configuration determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet. +**Note** + +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html .PARAMETER BidPrice + The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-bidprice PrimitiveType: String UpdateType: Immutable .PARAMETER BidPriceAsPercentageOfOnDemandPrice + The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number for example, 20 specifies 20%. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-bidpriceaspercentageofondemandprice PrimitiveType: Double UpdateType: Immutable .PARAMETER Configurations + Amazon EMR releases 4.x or later. +An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-configurations DuplicatesAllowed: False ItemType: Configuration @@ -28,16 +39,22 @@ function Add-VSEMRInstanceFleetConfigInstanceTypeConfig { UpdateType: Immutable .PARAMETER EbsConfiguration + The configuration of Amazon Elastic Block Storage EBS attached to each instance as defined by InstanceType. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-ebsconfiguration Type: EbsConfiguration UpdateType: Immutable .PARAMETER InstanceType + An EC2 instance type, such as m3.xlarge. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER WeightedCapacity + The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-weightedcapacity PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigSpotProvisioningSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigSpotProvisioningSpecification.ps1 index 2f5641440..29d7e765c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigSpotProvisioningSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigSpotProvisioningSpecification.ps1 @@ -1,26 +1,36 @@ function Add-VSEMRInstanceFleetConfigSpotProvisioningSpecification { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification resource property to the template. SpotProvisioningSpecification is a subproperty of the InstanceFleetProvisioningSpecifications property type. SpotProvisioningSpecification determines the launch specification for Spot instances in the instance fleet, which includes the defined duration and provisioning timeout behavior. .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification resource property to the template. +SpotProvisioningSpecification is a subproperty of the InstanceFleetProvisioningSpecifications property type. SpotProvisioningSpecification determines the launch specification for Spot instances in the instance fleet, which includes the defined duration and provisioning timeout behavior. +**Note** + +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html .PARAMETER BlockDurationMinutes + The defined duration for Spot instances also known as Spot blocks in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-blockdurationminutes PrimitiveType: Integer UpdateType: Mutable .PARAMETER TimeoutAction + The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-timeoutaction PrimitiveType: String UpdateType: Mutable .PARAMETER TimeoutDurationMinutes + The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-timeoutdurationminutes PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigVolumeSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigVolumeSpecification.ps1 index 6d31ace38..14d003d33 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigVolumeSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceFleetConfigVolumeSpecification.ps1 @@ -1,26 +1,32 @@ function Add-VSEMRInstanceFleetConfigVolumeSpecification { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig.VolumeSpecification resource property to the template. + Adds an AWS::EMR::InstanceFleetConfig.VolumeSpecification resource property to the template. VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type. VolumeSecification determines the volume type, IOPS, and size (GiB for EBS volumes attached to EC2 instances. .DESCRIPTION Adds an AWS::EMR::InstanceFleetConfig.VolumeSpecification resource property to the template. - +VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type. VolumeSecification determines the volume type, IOPS, and size (GiB for EBS volumes attached to EC2 instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-iops PrimitiveType: Integer UpdateType: Immutable .PARAMETER SizeInGB + The volume size, in gibibytes GiB. This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-sizeingb PrimitiveType: Integer UpdateType: Immutable .PARAMETER VolumeType + The volume type. Volume types supported are gp2, io1, standard. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-volumetype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigAutoScalingPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigAutoScalingPolicy.ps1 index 0ef9b1edd..e04dba6c9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigAutoScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigAutoScalingPolicy.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceGroupConfigAutoScalingPolicy { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.AutoScalingPolicy resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.AutoScalingPolicy resource property to the template. AutoScalingPolicy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. For more information, see Using Automatic Scaling in Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html in the *Amazon EMR Management Guide*. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.AutoScalingPolicy resource property to the template. - +AutoScalingPolicy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. For more information, see Using Automatic Scaling in Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html in the *Amazon EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html .PARAMETER Constraints + The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy-constraints Type: ScalingConstraints UpdateType: Mutable .PARAMETER Rules + The scale-in and scale-out rules that comprise the automatic scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy-rules DuplicatesAllowed: False ItemType: ScalingRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 index c525db42f..02f8773d2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition resource property to the template. CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity. Scaling activity begins when you satisfy the defined alarm conditions. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition resource property to the template. - +CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity. Scaling activity begins when you satisfy the defined alarm conditions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html .PARAMETER ComparisonOperator + Determines how the metric specified by MetricName is compared to the value specified by Threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER Dimensions + A CloudWatch metric dimension. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-dimensions DuplicatesAllowed: False ItemType: MetricDimension @@ -23,36 +27,50 @@ function Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition { UpdateType: Mutable .PARAMETER EvaluationPeriods + The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-evaluationperiods PrimitiveType: Integer UpdateType: Mutable .PARAMETER MetricName + The name of the CloudWatch metric that is watched to determine an alarm condition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Namespace + The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER Period + The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes 300 seconds, so if an EMR CloudWatch metric is specified, specify 300. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-period PrimitiveType: Integer UpdateType: Mutable .PARAMETER Statistic + The statistic to apply to the metric associated with the alarm. The default is AVERAGE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Threshold + The value against which the specified statistic is compared. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-threshold PrimitiveType: Double UpdateType: Mutable .PARAMETER Unit + The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigConfiguration.ps1 index 56f017e93..21970515b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigConfiguration.ps1 @@ -1,21 +1,31 @@ function Add-VSEMRInstanceGroupConfigConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.Configuration resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.Configuration resource property to the template. Configurations is a property of the AWS::EMR::Cluster resource that specifies the configuration of applications on an Amazon EMR cluster. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.Configuration resource property to the template. +Configurations is a property of the AWS::EMR::Cluster resource that specifies the configuration of applications on an Amazon EMR cluster. +Configurations are optional. You can use them to have EMR customize applications and software bundled with Amazon EMR when a cluster is created. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html. + +**Note** + +Applies only to Amazon EMR releases 4.0 and later. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html .PARAMETER Classification + The classification within a configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-classification PrimitiveType: String UpdateType: Immutable .PARAMETER ConfigurationProperties + Within a configuration classification, a set of properties that represent the settings that you want to change in the configuration file. Duplicates not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-configurationproperties DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +33,8 @@ function Add-VSEMRInstanceGroupConfigConfiguration { UpdateType: Immutable .PARAMETER Configurations + A list of additional configurations to apply within a configuration object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-configurations DuplicatesAllowed: False ItemType: Configuration diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsBlockDeviceConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsBlockDeviceConfig.ps1 index 7e4acf4cc..22547d137 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsBlockDeviceConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsBlockDeviceConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceGroupConfigEbsBlockDeviceConfig { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig resource property to the template. Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig resource property to the template. - +Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html .PARAMETER VolumeSpecification + EBS volume specifications such as volume type, IOPS, and size GiB that will be requested for the EBS volume attached to an EC2 instance in the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification Type: VolumeSpecification UpdateType: Mutable .PARAMETER VolumesPerInstance + Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumesperinstance PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsConfiguration.ps1 index 9b9c6910c..b84b0f83a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigEbsConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRInstanceGroupConfigEbsConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.EbsConfiguration resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.EbsConfiguration resource property to the template. The Amazon EBS configuration of a cluster instance. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.EbsConfiguration resource property to the template. - +The Amazon EBS configuration of a cluster instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html .PARAMETER EbsBlockDeviceConfigs + An array of Amazon EBS volume specifications attached to a cluster instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfigs DuplicatesAllowed: False ItemType: EbsBlockDeviceConfig @@ -18,6 +20,8 @@ function Add-VSEMRInstanceGroupConfigEbsConfiguration { UpdateType: Mutable .PARAMETER EbsOptimized + Indicates whether an Amazon EBS volume is EBS-optimized. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html#cfn-emr-ebsconfiguration-ebsoptimized PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigMetricDimension.ps1 index 5921117d2..74f7c5b4a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigMetricDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceGroupConfigMetricDimension { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.MetricDimension resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.MetricDimension resource property to the template. MetricDimension is a subproperty of the CloudWatchAlarmDefinition property type. MetricDimension specifies a CloudWatch dimension, which is specified with a Key Value pair. The key is known as a Name in CloudWatch. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the automatic scaling rule for EMR to bootstrap when the cluster ID becomes available during cluster creation. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.MetricDimension resource property to the template. - +MetricDimension is a subproperty of the CloudWatchAlarmDefinition property type. MetricDimension specifies a CloudWatch dimension, which is specified with a Key Value pair. The key is known as a Name in CloudWatch. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the automatic scaling rule for EMR to bootstrap when the cluster ID becomes available during cluster creation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html .PARAMETER Key + The dimension name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html#cfn-elasticmapreduce-instancegroupconfig-metricdimension-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The dimension value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html#cfn-elasticmapreduce-instancegroupconfig-metricdimension-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingAction.ps1 index 8f8b20f20..b2b83e8fc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingAction.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceGroupConfigScalingAction { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.ScalingAction resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.ScalingAction resource property to the template. ScalingAction is a subproperty of the ScalingRule property type. ScalingAction determines the type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.ScalingAction resource property to the template. - +ScalingAction is a subproperty of the ScalingRule property type. ScalingAction determines the type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html .PARAMETER Market + Not available for instance groups. Instance groups use the market type specified for the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html#cfn-elasticmapreduce-instancegroupconfig-scalingaction-market PrimitiveType: String UpdateType: Mutable .PARAMETER SimpleScalingPolicyConfiguration + The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html#cfn-elasticmapreduce-instancegroupconfig-scalingaction-simplescalingpolicyconfiguration Type: SimpleScalingPolicyConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingConstraints.ps1 index 7138a9baf..1064ffe98 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingConstraints.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRInstanceGroupConfigScalingConstraints { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.ScalingConstraints resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.ScalingConstraints resource property to the template. ScalingConstraints is a subproperty of the AutoScalingPolicy property type. ScalingConstraints defines the upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or shrink below these limits. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.ScalingConstraints resource property to the template. - +ScalingConstraints is a subproperty of the AutoScalingPolicy property type. ScalingConstraints defines the upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or shrink below these limits. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html .PARAMETER MaxCapacity + The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html#cfn-elasticmapreduce-instancegroupconfig-scalingconstraints-maxcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinCapacity + The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html#cfn-elasticmapreduce-instancegroupconfig-scalingconstraints-mincapacity PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingRule.ps1 index 9353123cf..90eeee0c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingRule.ps1 @@ -1,31 +1,39 @@ function Add-VSEMRInstanceGroupConfigScalingRule { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.ScalingRule resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.ScalingRule resource property to the template. ScalingRule is a subproperty of the AutoScalingPolicy property type. ScalingRule defines the scale-in or scale-out rules for scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.ScalingRule resource property to the template. - +ScalingRule is a subproperty of the AutoScalingPolicy property type. ScalingRule defines the scale-in or scale-out rules for scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html .PARAMETER Action + The conditions that trigger an automatic scaling activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-action Type: ScalingAction UpdateType: Mutable .PARAMETER Description + A friendly, more verbose description of the automatic scaling rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-description PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-name PrimitiveType: String UpdateType: Mutable .PARAMETER Trigger + The CloudWatch alarm definition that determines when automatic scaling activity is triggered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-trigger Type: ScalingTrigger UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingTrigger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingTrigger.ps1 index 69c0ccae3..442c18662 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingTrigger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigScalingTrigger.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRInstanceGroupConfigScalingTrigger { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.ScalingTrigger resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.ScalingTrigger resource property to the template. ScalingTrigger is a subproperty of the ScalingRule property type. ScalingTrigger determines the conditions that trigger an automatic scaling activity. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.ScalingTrigger resource property to the template. - +ScalingTrigger is a subproperty of the ScalingRule property type. ScalingTrigger determines the conditions that trigger an automatic scaling activity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingtrigger.html .PARAMETER CloudWatchAlarmDefinition + The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingtrigger.html#cfn-elasticmapreduce-instancegroupconfig-scalingtrigger-cloudwatchalarmdefinition Type: CloudWatchAlarmDefinition UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigSimpleScalingPolicyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigSimpleScalingPolicyConfiguration.ps1 index 7610cb4c2..61f2ed75b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigSimpleScalingPolicyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigSimpleScalingPolicyConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSEMRInstanceGroupConfigSimpleScalingPolicyConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration resource property to the template. SimpleScalingPolicyConfiguration is a subproperty of the ScalingAction property type. SimpleScalingPolicyConfiguration determines how an automatic scaling action adds or removes instances, the cooldown period, and the number of EC2 instances that are added each time the CloudWatch metric alarm condition is satisfied. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration resource property to the template. - +SimpleScalingPolicyConfiguration is a subproperty of the ScalingAction property type. SimpleScalingPolicyConfiguration determines how an automatic scaling action adds or removes instances, the cooldown period, and the number of EC2 instances that are added each time the CloudWatch metric alarm condition is satisfied. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html .PARAMETER AdjustmentType + The way in which EC2 instances are added if ScalingAdjustment is a positive number or terminated if ScalingAdjustment is a negative number each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-adjustmenttype PrimitiveType: String UpdateType: Mutable .PARAMETER CoolDown + The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-cooldown PrimitiveType: Integer UpdateType: Mutable .PARAMETER ScalingAdjustment + The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-scalingadjustment PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigVolumeSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigVolumeSpecification.ps1 index 3870eba62..860fca7b0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigVolumeSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigVolumeSpecification.ps1 @@ -1,26 +1,32 @@ function Add-VSEMRInstanceGroupConfigVolumeSpecification { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig.VolumeSpecification resource property to the template. + Adds an AWS::EMR::InstanceGroupConfig.VolumeSpecification resource property to the template. VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type. VolumeSecification determines the volume type, IOPS, and size (GiB for EBS volumes attached to EC2 instances. .DESCRIPTION Adds an AWS::EMR::InstanceGroupConfig.VolumeSpecification resource property to the template. - +VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type. VolumeSecification determines the volume type, IOPS, and size (GiB for EBS volumes attached to EC2 instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER SizeInGB + The volume size, in gibibytes GiB. This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-sizeingb PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type. Volume types supported are gp2, io1, standard. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRStepHadoopJarStepConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRStepHadoopJarStepConfig.ps1 index b792299cc..eae7e5032 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRStepHadoopJarStepConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRStepHadoopJarStepConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSEMRStepHadoopJarStepConfig { <# .SYNOPSIS - Adds an AWS::EMR::Step.HadoopJarStepConfig resource property to the template. + Adds an AWS::EMR::Step.HadoopJarStepConfig resource property to the template. A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail. .DESCRIPTION Adds an AWS::EMR::Step.HadoopJarStepConfig resource property to the template. - +A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html .PARAMETER Args + A list of command line arguments passed to the JAR file's main function when executed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-args DuplicatesAllowed: False PrimitiveItemType: String @@ -18,16 +20,22 @@ function Add-VSEMRStepHadoopJarStepConfig { UpdateType: Immutable .PARAMETER Jar + A path to a JAR file run during the step. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-jar PrimitiveType: String UpdateType: Immutable .PARAMETER MainClass + The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-mainclass PrimitiveType: String UpdateType: Immutable .PARAMETER StepProperties + A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-stepproperties DuplicatesAllowed: False ItemType: KeyValue diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRStepKeyValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRStepKeyValue.ps1 index 546e07ee8..ee7c1376f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRStepKeyValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRStepKeyValue.ps1 @@ -1,21 +1,25 @@ function Add-VSEMRStepKeyValue { <# .SYNOPSIS - Adds an AWS::EMR::Step.KeyValue resource property to the template. + Adds an AWS::EMR::Step.KeyValue resource property to the template. KeyValue is a subproperty of the HadoopJarStepConfig property type. KeyValue is used to pass parameters to a step. .DESCRIPTION Adds an AWS::EMR::Step.KeyValue resource property to the template. - +KeyValue is a subproperty of the HadoopJarStepConfig property type. KeyValue is used to pass parameters to a step. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-keyvalue.html .PARAMETER Key + The unique identifier of a key value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-keyvalue.html#cfn-elasticmapreduce-step-keyvalue-key PrimitiveType: String UpdateType: Immutable .PARAMETER Value + The value part of the identified key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-keyvalue.html#cfn-elasticmapreduce-step-keyvalue-value PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElastiCacheReplicationGroupNodeGroupConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElastiCacheReplicationGroupNodeGroupConfiguration.ps1 index b72f10f0b..51b112e65 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElastiCacheReplicationGroupNodeGroupConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElastiCacheReplicationGroupNodeGroupConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSElastiCacheReplicationGroupNodeGroupConfiguration { <# .SYNOPSIS - Adds an AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration resource property to the template. + Adds an AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration resource property to the template. NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache Redis cluster node group. .DESCRIPTION Adds an AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration resource property to the template. - +NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache Redis cluster node group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html .PARAMETER NodeGroupId + Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-nodegroupid PrimitiveType: String UpdateType: Conditional .PARAMETER PrimaryAvailabilityZone + The Availability Zone where the primary node of this node group shard is launched. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-primaryavailabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER ReplicaAvailabilityZones + A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicaavailabilityzones DuplicatesAllowed: False PrimitiveItemType: String @@ -28,11 +34,17 @@ function Add-VSElastiCacheReplicationGroupNodeGroupConfiguration { UpdateType: Immutable .PARAMETER ReplicaCount + The number of read replica nodes in this node group shard. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicacount PrimitiveType: Integer UpdateType: Immutable .PARAMETER Slots + A string of comma-separated values where the first set of values are the slot numbers zero based, and the second set of values are the keyspaces for each slot. The following example specifies three slots numbered 0, 1, and 2: 0,1,2,0-4999,5000-9999,10000-16,383. +If you don't specify a value, ElastiCache allocates keys equally among each slot. +When you use an UseOnlineResharding update policy to update the number of node groups without interruption, ElastiCache evenly distributes the keyspaces between the specified number of slots. This cannot be updated later. Therefore, after updating the number of node groups in this way, you should remove the value specified for the Slots property of each NodeGroupConfiguration from the stack template, as it no longer reflects the actual values in each node group. For more information, see UseOnlineResharding Policy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-slots PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 index 7a694bba8..0d6d9ced5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 @@ -1,21 +1,27 @@ function Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig resource property to the template. + Adds an AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig resource property to the template. The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions. .DESCRIPTION Adds an AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig resource property to the template. +The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions. +ApplicationResourceLifecycleConfig is a property of the AWS::ElasticBeanstalk::Application: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html .PARAMETER ServiceRole + The ARN of an IAM service role that Elastic Beanstalk has permission to assume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-servicerole PrimitiveType: String UpdateType: Mutable .PARAMETER VersionLifecycleConfig + Defines lifecycle settings for application versions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-versionlifecycleconfig Type: ApplicationVersionLifecycleConfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationVersionLifecycleConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationVersionLifecycleConfig.ps1 index c3db0df05..c7b1540ec 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationVersionLifecycleConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationVersionLifecycleConfig.ps1 @@ -1,21 +1,29 @@ function Add-VSElasticBeanstalkApplicationApplicationVersionLifecycleConfig { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig resource property to the template. + Adds an AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig resource property to the template. The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions. .DESCRIPTION Adds an AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig resource property to the template. +The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions. +When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it. + +ApplicationVersionLifecycleConfig is a property of the ApplicationResourceLifecycleConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html .PARAMETER MaxAgeRule + Specify a max age rule to restrict the length of time that application versions are retained for an application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxagerule Type: MaxAgeRule UpdateType: Mutable .PARAMETER MaxCountRule + Specify a max count rule to restrict the number of application versions that are retained for an application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxcountrule Type: MaxCountRule UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxAgeRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxAgeRule.ps1 index db34944f7..22c32e37b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxAgeRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxAgeRule.ps1 @@ -1,26 +1,34 @@ function Add-VSElasticBeanstalkApplicationMaxAgeRule { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Application.MaxAgeRule resource property to the template. + Adds an AWS::ElasticBeanstalk::Application.MaxAgeRule resource property to the template. A lifecycle rule that deletes application versions after the specified number of days. .DESCRIPTION Adds an AWS::ElasticBeanstalk::Application.MaxAgeRule resource property to the template. +A lifecycle rule that deletes application versions after the specified number of days. +MaxAgeRule is a property of the ApplicationVersionLifecycleConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html .PARAMETER DeleteSourceFromS3 + Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-deletesourcefroms3 PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Enabled + Specify true to apply the rule, or false to disable it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MaxAgeInDays + Specify the number of days to retain an application versions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-maxageindays PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxCountRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxCountRule.ps1 index 7da0ebfe7..cd3a1f771 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxCountRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationMaxCountRule.ps1 @@ -1,26 +1,34 @@ function Add-VSElasticBeanstalkApplicationMaxCountRule { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Application.MaxCountRule resource property to the template. + Adds an AWS::ElasticBeanstalk::Application.MaxCountRule resource property to the template. A lifecycle rule that deletes the oldest application version when the maximum count is exceeded. .DESCRIPTION Adds an AWS::ElasticBeanstalk::Application.MaxCountRule resource property to the template. +A lifecycle rule that deletes the oldest application version when the maximum count is exceeded. +MaxCountRule is a property of the ApplicationVersionLifecycleConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html .PARAMETER DeleteSourceFromS3 + Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-deletesourcefroms3 PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Enabled + Specify true to apply the rule, or false to disable it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MaxCount + Specify the maximum number of application versions to retain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-maxcount PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationVersionSourceBundle.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationVersionSourceBundle.ps1 index 38b0999cb..5f68c2ca0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationVersionSourceBundle.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationVersionSourceBundle.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticBeanstalkApplicationVersionSourceBundle { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle resource property to the template. + Adds an AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle resource property to the template. The SourceBundle property is an embedded property of the AWS::ElasticBeanstalk::ApplicationVersion: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html resource. It specifies the Amazon S3 location of the source bundle for an AWS Elastic Beanstalk application version. .DESCRIPTION Adds an AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle resource property to the template. - +The SourceBundle property is an embedded property of the AWS::ElasticBeanstalk::ApplicationVersion: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html resource. It specifies the Amazon S3 location of the source bundle for an AWS Elastic Beanstalk application version. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html .PARAMETER S3Bucket + The Amazon S3 bucket where the data is located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html#cfn-beanstalk-sourcebundle-s3bucket PrimitiveType: String UpdateType: Mutable .PARAMETER S3Key + The Amazon S3 key where the data is located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html#cfn-beanstalk-sourcebundle-s3key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateConfigurationOptionSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateConfigurationOptionSetting.ps1 index 5bc6bd8bd..69722d86f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateConfigurationOptionSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateConfigurationOptionSetting.ps1 @@ -1,31 +1,43 @@ function Add-VSElasticBeanstalkConfigurationTemplateConfigurationOptionSetting { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting resource property to the template. + Adds an AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting resource property to the template. The ConfigurationOptionSetting property type specifies an option for an AWS Elastic Beanstalk configuration template. .DESCRIPTION Adds an AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting resource property to the template. +The ConfigurationOptionSetting property type specifies an option for an AWS Elastic Beanstalk configuration template. +The OptionSettings property of the AWS::ElasticBeanstalk::ConfigurationTemplate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html resource contains a list of ConfigurationOptionSetting property types. + +For a list of possible namespaces and option values, see Option Values: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html in the *AWS Elastic Beanstalk Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html .PARAMETER Namespace + A unique namespace that identifies the option's associated AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER OptionName + The name of the configuration option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-optionname PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceName + A unique resource name for the option setting. Use it for a time–based scaling configuration option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-resourcename PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The current value for the configuration option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateSourceConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateSourceConfiguration.ps1 index 10576d5d8..d4e705d10 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateSourceConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkConfigurationTemplateSourceConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticBeanstalkConfigurationTemplateSourceConfiguration { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration resource property to the template. + Adds an AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration resource property to the template. An AWS Elastic Beanstalk configuration template to base a new one on. You can use it to define a AWS::ElasticBeanstalk::ConfigurationTemplate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html resource. .DESCRIPTION Adds an AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration resource property to the template. - +An AWS Elastic Beanstalk configuration template to base a new one on. You can use it to define a AWS::ElasticBeanstalk::ConfigurationTemplate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html .PARAMETER ApplicationName + The name of the application associated with the configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-applicationname PrimitiveType: String UpdateType: Mutable .PARAMETER TemplateName + The name of the configuration template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-templatename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentOptionSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentOptionSetting.ps1 index ffba3722b..6fd0060a2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentOptionSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentOptionSetting.ps1 @@ -1,31 +1,43 @@ function Add-VSElasticBeanstalkEnvironmentOptionSetting { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Environment.OptionSetting resource property to the template. + Adds an AWS::ElasticBeanstalk::Environment.OptionSetting resource property to the template. The OptionSetting property type specifies an option for an AWS Elastic Beanstalk environment. .DESCRIPTION Adds an AWS::ElasticBeanstalk::Environment.OptionSetting resource property to the template. +The OptionSetting property type specifies an option for an AWS Elastic Beanstalk environment. +The OptionSettings property of the AWS::ElasticBeanstalk::Environment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html resource contains a list of OptionSetting property types. + +For a list of possible namespaces and option values, see Option Values: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html in the *AWS Elastic Beanstalk Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html .PARAMETER Namespace + A unique namespace that identifies the option's associated AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-beanstalk-optionsettings-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER OptionName + The name of the configuration option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-beanstalk-optionsettings-optionname PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceName + A unique resource name for the option setting. Use it for a time–based scaling configuration option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-elasticbeanstalk-environment-optionsetting-resourcename PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The current value for the configuration option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-beanstalk-optionsettings-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentTier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentTier.ps1 index 141be0d23..81b00a564 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentTier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkEnvironmentTier.ps1 @@ -1,26 +1,39 @@ function Add-VSElasticBeanstalkEnvironmentTier { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Environment.Tier resource property to the template. + Adds an AWS::ElasticBeanstalk::Environment.Tier resource property to the template. Describes the environment tier for an AWS::ElasticBeanstalk::Environment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html resource. For more information, see Environment Tiers: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html in the *AWS Elastic Beanstalk Developer Guide*. .DESCRIPTION Adds an AWS::ElasticBeanstalk::Environment.Tier resource property to the template. - +Describes the environment tier for an AWS::ElasticBeanstalk::Environment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html resource. For more information, see Environment Tiers: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html in the *AWS Elastic Beanstalk Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html .PARAMETER Name + The name of this environment tier. +Valid values: ++ For *Web server tier* – WebServer ++ For *Worker tier* – Worker + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html#cfn-beanstalk-env-tier-name PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of this environment tier. +Valid values: ++ For *Web server tier* – Standard ++ For *Worker tier* – SQS/HTTP + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html#cfn-beanstalk-env-tier-type PrimitiveType: String UpdateType: Immutable .PARAMETER Version + The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. +This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html#cfn-beanstalk-env-tier-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAccessLoggingPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAccessLoggingPolicy.ps1 index 13f64d906..e741c35f6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAccessLoggingPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAccessLoggingPolicy.ps1 @@ -1,31 +1,40 @@ function Add-VSElasticLoadBalancingLoadBalancerAccessLoggingPolicy { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy resource property to the template. Specifies where and how access logs are stored for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy resource property to the template. - +Specifies where and how access logs are stored for your Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html .PARAMETER EmitInterval + The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes. +Default: 60 minutes + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-emitinterval PrimitiveType: Integer UpdateType: Mutable .PARAMETER Enabled + Specifies whether access logs are enabled for the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER S3BucketName + The name of the Amazon S3 bucket where the access logs are stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-s3bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER S3BucketPrefix + The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-s3bucketprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAppCookieStickinessPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAppCookieStickinessPolicy.ps1 index 417714782..a469ab734 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAppCookieStickinessPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerAppCookieStickinessPolicy.ps1 @@ -1,21 +1,27 @@ function Add-VSElasticLoadBalancingLoadBalancerAppCookieStickinessPolicy { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy resource property to the template. Specifies a policy for application-controlled session stickiness for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy resource property to the template. +Specifies a policy for application-controlled session stickiness for your Classic Load Balancer. +To associate a policy with a listener, use the PolicyNames: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-policynames property for the listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html .PARAMETER CookieName + The name of the application cookie used for stickiness. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html#cfn-elb-appcookiestickinesspolicy-cookiename PrimitiveType: String UpdateType: Mutable .PARAMETER PolicyName + The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html#cfn-elb-appcookiestickinesspolicy-policyname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionDrainingPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionDrainingPolicy.ps1 index 4d5e2a64f..457621eca 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionDrainingPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionDrainingPolicy.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingLoadBalancerConnectionDrainingPolicy { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy resource property to the template. Specifies the connection draining settings for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy resource property to the template. - +Specifies the connection draining settings for your Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html .PARAMETER Enabled + Specifies whether connection draining is enabled for the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html#cfn-elb-connectiondrainingpolicy-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Timeout + The maximum time, in seconds, to keep the existing connections open before deregistering the instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html#cfn-elb-connectiondrainingpolicy-timeout PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionSettings.ps1 index c71dda9a1..01bbb0176 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerConnectionSettings.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingLoadBalancerConnectionSettings { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings resource property to the template. Specifies the idle timeout value for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings resource property to the template. - +Specifies the idle timeout value for your Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectionsettings.html .PARAMETER IdleTimeout + The time, in seconds, that the connection is allowed to be idle no data has been sent over the connection before it is closed by the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectionsettings.html#cfn-elb-connectionsettings-idletimeout PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerHealthCheck.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerHealthCheck.ps1 index 90efc3001..1367cc359 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerHealthCheck.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerHealthCheck.ps1 @@ -1,36 +1,51 @@ function Add-VSElasticLoadBalancingLoadBalancerHealthCheck { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck resource property to the template. Specifies health check settings for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck resource property to the template. - +Specifies health check settings for your Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html .PARAMETER HealthyThreshold + The number of consecutive health checks successes required before moving the instance to the Healthy state. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-healthythreshold PrimitiveType: String UpdateType: Mutable .PARAMETER Interval + The approximate interval, in seconds, between health checks of an individual instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-interval PrimitiveType: String UpdateType: Mutable .PARAMETER Target + The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one 1 through 65535. +TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. +SSL is also specified as SSL: port pair, for example, SSL:5000. +For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. +The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-target PrimitiveType: String UpdateType: Mutable .PARAMETER Timeout + The amount of time, in seconds, during which no response means a failed health check. +This value must be less than the Interval value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-timeout PrimitiveType: String UpdateType: Mutable .PARAMETER UnhealthyThreshold + The number of consecutive health check failures required before moving the instance to the Unhealthy state. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-unhealthythreshold PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerLBCookieStickinessPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerLBCookieStickinessPolicy.ps1 index 839179467..31c03e419 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerLBCookieStickinessPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerLBCookieStickinessPolicy.ps1 @@ -1,21 +1,27 @@ function Add-VSElasticLoadBalancingLoadBalancerLBCookieStickinessPolicy { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy resource property to the template. Specifies a policy for duration-based session stickiness for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy resource property to the template. +Specifies a policy for duration-based session stickiness for your Classic Load Balancer. +To associate a policy with a listener, use the PolicyNames: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-policynames property for the listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html .PARAMETER CookieExpirationPeriod + The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html#cfn-elb-lbcookiestickinesspolicy-cookieexpirationperiod PrimitiveType: String UpdateType: Mutable .PARAMETER PolicyName + The name of the policy. This name must be unique within the set of policies for this load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html#cfn-elb-lbcookiestickinesspolicy-policyname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerListeners.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerListeners.ps1 index e022de55c..59684fce8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerListeners.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerListeners.ps1 @@ -1,31 +1,42 @@ function Add-VSElasticLoadBalancingLoadBalancerListeners { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.Listeners resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.Listeners resource property to the template. Specifies a listener for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.Listeners resource property to the template. - +Specifies a listener for your Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html .PARAMETER InstancePort + The port on which the instance is listening. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-instanceport PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceProtocol + The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL. +If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol. +If there is another listener with the same InstancePort whose InstanceProtocol is secure, HTTPS or SSL, the listener's InstanceProtocol must also be secure. +If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-instanceprotocol PrimitiveType: String UpdateType: Mutable .PARAMETER LoadBalancerPort + The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-loadbalancerport PrimitiveType: String UpdateType: Mutable .PARAMETER PolicyNames + The names of the policies to associate with the listener. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-policynames DuplicatesAllowed: False PrimitiveItemType: String @@ -33,11 +44,15 @@ function Add-VSElasticLoadBalancingLoadBalancerListeners { UpdateType: Mutable .PARAMETER Protocol + The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER SSLCertificateId + The Amazon Resource Name ARN of the server certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-sslcertificateid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerPolicies.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerPolicies.ps1 index 03151feca..275361932 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerPolicies.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingLoadBalancerPolicies.ps1 @@ -1,16 +1,20 @@ function Add-VSElasticLoadBalancingLoadBalancerPolicies { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer.Policies resource property to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer.Policies resource property to the template. Specifies policies for your Classic Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancing::LoadBalancer.Policies resource property to the template. +Specifies policies for your Classic Load Balancer. +To associate policies with a listener, use the PolicyNames: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-policynames property for the listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html .PARAMETER Attributes + The policy attributes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-attributes DuplicatesAllowed: False PrimitiveItemType: Json @@ -18,6 +22,8 @@ function Add-VSElasticLoadBalancingLoadBalancerPolicies { UpdateType: Mutable .PARAMETER InstancePorts + The instance ports for the policy. Required only for some policy types. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-instanceports DuplicatesAllowed: False PrimitiveItemType: String @@ -25,6 +31,8 @@ function Add-VSElasticLoadBalancingLoadBalancerPolicies { UpdateType: Mutable .PARAMETER LoadBalancerPorts + The load balancer ports for the policy. Required only for some policy types. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-loadbalancerports DuplicatesAllowed: False PrimitiveItemType: String @@ -32,11 +40,15 @@ function Add-VSElasticLoadBalancingLoadBalancerPolicies { UpdateType: Mutable .PARAMETER PolicyName + The name of the policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-policyname PrimitiveType: String UpdateType: Mutable .PARAMETER PolicyType + The name of the policy type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-policytype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 index bb8c1dc05..1e58f6a90 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 @@ -1,51 +1,67 @@ function Add-VSElasticLoadBalancingV2ListenerAction { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.Action resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.Action resource property to the template. Specifies an action for a listener rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.Action resource property to the template. - +Specifies an action for a listener rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html .PARAMETER AuthenticateCognitoConfig + HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig Type: AuthenticateCognitoConfig UpdateType: Mutable .PARAMETER AuthenticateOidcConfig + HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect OIDC. Specify only when Type is authenticate-oidc. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig Type: AuthenticateOidcConfig UpdateType: Mutable .PARAMETER FixedResponseConfig + Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig Type: FixedResponseConfig UpdateType: Mutable .PARAMETER ForwardConfig + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig Type: ForwardConfig UpdateType: Mutable .PARAMETER Order + The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a forward or a fixed-response action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-order PrimitiveType: Integer UpdateType: Mutable .PARAMETER RedirectConfig + Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig Type: RedirectConfig UpdateType: Mutable .PARAMETER TargetGroupArn + The Amazon Resource Name ARN of the target group. Specify only when Type is forward. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-targetgrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig.ps1 index 24c168d48..f5b7ef689 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. - +Specifies information required when integrating with Amazon Cognito to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html .PARAMETER AuthenticationRequestExtraParams + The query parameters up to 10 to include in the redirect request to the authorization endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams DuplicatesAllowed: False PrimitiveItemType: String @@ -18,36 +20,54 @@ function Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig { UpdateType: Mutable .PARAMETER OnUnauthenticatedRequest + The behavior if the user is not authenticated. The following are possible values: ++ deny - Return an HTTP 401 Unauthorized error. ++ allow - Allow the request to be forwarded to the target. ++ authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest PrimitiveType: String UpdateType: Mutable .PARAMETER Scope + The set of user claims to be requested from the IdP. The default is openid. +To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope PrimitiveType: String UpdateType: Mutable .PARAMETER SessionCookieName + The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename PrimitiveType: String UpdateType: Mutable .PARAMETER SessionTimeout + The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout PrimitiveType: Long UpdateType: Mutable .PARAMETER UserPoolArn + The Amazon Resource Name ARN of the Amazon Cognito user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolClientId + The ID of the Amazon Cognito user pool client. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolDomain + The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig.ps1 index bbc1d6bf8..33275f5ef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig resource property to the template. Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig resource property to the template. - +Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html .PARAMETER AuthenticationRequestExtraParams + The query parameters up to 10 to include in the redirect request to the authorization endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authenticationrequestextraparams DuplicatesAllowed: False PrimitiveItemType: String @@ -18,51 +20,75 @@ function Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig { UpdateType: Mutable .PARAMETER AuthorizationEndpoint + The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authorizationendpoint PrimitiveType: String UpdateType: Mutable .PARAMETER ClientId + The OAuth 2.0 client identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientid PrimitiveType: String UpdateType: Mutable .PARAMETER ClientSecret + The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientsecret PrimitiveType: String UpdateType: Mutable .PARAMETER Issuer + The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-issuer PrimitiveType: String UpdateType: Mutable .PARAMETER OnUnauthenticatedRequest + The behavior if the user is not authenticated. The following are possible values: ++ deny - Return an HTTP 401 Unauthorized error. ++ allow - Allow the request to be forwarded to the target. ++ authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-onunauthenticatedrequest PrimitiveType: String UpdateType: Mutable .PARAMETER Scope + The set of user claims to be requested from the IdP. The default is openid. +To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-scope PrimitiveType: String UpdateType: Mutable .PARAMETER SessionCookieName + The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessioncookiename PrimitiveType: String UpdateType: Mutable .PARAMETER SessionTimeout + The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessiontimeout PrimitiveType: Long UpdateType: Mutable .PARAMETER TokenEndpoint + The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-tokenendpoint PrimitiveType: String UpdateType: Mutable .PARAMETER UserInfoEndpoint + The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-userinfoendpoint PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificate.ps1 index 00f425358..507e9c521 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificate.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingV2ListenerCertificate { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.Certificate resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.Certificate resource property to the template. Specifies an SSL server certificate. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.Certificate resource property to the template. - +Specifies an SSL server certificate. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html .PARAMETER CertificateArn + The Amazon Resource Name ARN of the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificateCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificateCertificate.ps1 index 9248c5e76..559ffc0f6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificateCertificate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerCertificateCertificate.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingV2ListenerCertificateCertificate { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate resource property to the template. Specifies an SSL server certificate. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate resource property to the template. - +Specifies an SSL server certificate. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html .PARAMETER CertificateArn + The Amazon Resource Name ARN of the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerFixedResponseConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerFixedResponseConfig.ps1 index c14f26190..465ce0cd1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerFixedResponseConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerFixedResponseConfig.ps1 @@ -1,26 +1,33 @@ function Add-VSElasticLoadBalancingV2ListenerFixedResponseConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig resource property to the template. Specifies information required when returning a custom HTTP response. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig resource property to the template. - +Specifies information required when returning a custom HTTP response. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html .PARAMETER ContentType + The content type. +Valid Values: text/plain | text/css | text/html | application/javascript | application/json + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-contenttype PrimitiveType: String UpdateType: Mutable .PARAMETER MessageBody + The message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-messagebody PrimitiveType: String UpdateType: Mutable .PARAMETER StatusCode + The HTTP response code 2XX, 4XX, or 5XX. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRedirectConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRedirectConfig.ps1 index 3f30e9de7..4385f30f7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRedirectConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRedirectConfig.ps1 @@ -1,41 +1,69 @@ function Add-VSElasticLoadBalancingV2ListenerRedirectConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.RedirectConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.RedirectConfig resource property to the template. Information about a redirect action. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.RedirectConfig resource property to the template. +Information about a redirect action. +A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. + +You can reuse URI components using the following reserved keywords: + ++ #{protocol} + ++ #{host} + ++ #{port} + ++ #{path} (the leading "/" is removed + ++ #{query} + +For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html .PARAMETER Host + The hostname. This component is not percent-encoded. The hostname can contain #{host}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-host PrimitiveType: String UpdateType: Mutable .PARAMETER Path + The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-path PrimitiveType: String UpdateType: Mutable .PARAMETER Port + The port. You can specify a value from 1 to 65535 or #{port}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-port PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol + The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER Query + The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-query PrimitiveType: String UpdateType: Mutable .PARAMETER StatusCode + The HTTP redirect code. The redirect is either permanent HTTP 301 or temporary HTTP 302. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 index 66efb36b2..a9bcf1ded 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 @@ -1,51 +1,67 @@ function Add-VSElasticLoadBalancingV2ListenerRuleAction { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.Action resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.Action resource property to the template. Specifies an action for a listener rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.Action resource property to the template. - +Specifies an action for a listener rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html .PARAMETER AuthenticateCognitoConfig + HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticatecognitoconfig Type: AuthenticateCognitoConfig UpdateType: Mutable .PARAMETER AuthenticateOidcConfig + HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect OIDC. Specify only when Type is authenticate-oidc. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticateoidcconfig Type: AuthenticateOidcConfig UpdateType: Mutable .PARAMETER FixedResponseConfig + Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-fixedresponseconfig Type: FixedResponseConfig UpdateType: Mutable .PARAMETER ForwardConfig + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-forwardconfig Type: ForwardConfig UpdateType: Mutable .PARAMETER Order + The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a forward or a fixed-response action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-order PrimitiveType: Integer UpdateType: Mutable .PARAMETER RedirectConfig + Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-redirectconfig Type: RedirectConfig UpdateType: Mutable .PARAMETER TargetGroupArn + The Amazon Resource Name ARN of the target group. Specify only when Type is forward. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-targetgrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig.ps1 index beda70624..2c1e208dc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig resource property to the template. - +Specifies information required when integrating with Amazon Cognito to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html .PARAMETER AuthenticationRequestExtraParams + The query parameters up to 10 to include in the redirect request to the authorization endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-authenticationrequestextraparams DuplicatesAllowed: False PrimitiveItemType: String @@ -18,36 +20,54 @@ function Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig { UpdateType: Mutable .PARAMETER OnUnauthenticatedRequest + The behavior if the user is not authenticated. The following are possible values: ++ deny - Return an HTTP 401 Unauthorized error. ++ allow - Allow the request to be forwarded to the target. ++ authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-onunauthenticatedrequest PrimitiveType: String UpdateType: Mutable .PARAMETER Scope + The set of user claims to be requested from the IdP. The default is openid. +To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-scope PrimitiveType: String UpdateType: Mutable .PARAMETER SessionCookieName + The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessioncookiename PrimitiveType: String UpdateType: Mutable .PARAMETER SessionTimeout + The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessiontimeout PrimitiveType: Long UpdateType: Mutable .PARAMETER UserPoolArn + The Amazon Resource Name ARN of the Amazon Cognito user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolarn PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolClientId + The ID of the Amazon Cognito user pool client. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolclientid PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolDomain + The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpooldomain PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig.ps1 index a02f2851b..6c5fe7369 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig resource property to the template. Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig resource property to the template. - +Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html .PARAMETER AuthenticationRequestExtraParams + The query parameters up to 10 to include in the redirect request to the authorization endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authenticationrequestextraparams DuplicatesAllowed: False PrimitiveItemType: String @@ -18,51 +20,75 @@ function Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig { UpdateType: Mutable .PARAMETER AuthorizationEndpoint + The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authorizationendpoint PrimitiveType: String UpdateType: Mutable .PARAMETER ClientId + The OAuth 2.0 client identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientid PrimitiveType: String UpdateType: Mutable .PARAMETER ClientSecret + The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientsecret PrimitiveType: String UpdateType: Mutable .PARAMETER Issuer + The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-issuer PrimitiveType: String UpdateType: Mutable .PARAMETER OnUnauthenticatedRequest + The behavior if the user is not authenticated. The following are possible values: ++ deny - Return an HTTP 401 Unauthorized error. ++ allow - Allow the request to be forwarded to the target. ++ authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-onunauthenticatedrequest PrimitiveType: String UpdateType: Mutable .PARAMETER Scope + The set of user claims to be requested from the IdP. The default is openid. +To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-scope PrimitiveType: String UpdateType: Mutable .PARAMETER SessionCookieName + The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessioncookiename PrimitiveType: String UpdateType: Mutable .PARAMETER SessionTimeout + The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessiontimeout PrimitiveType: Long UpdateType: Mutable .PARAMETER TokenEndpoint + The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-tokenendpoint PrimitiveType: String UpdateType: Mutable .PARAMETER UserInfoEndpoint + The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-userinfoendpoint PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig.ps1 index dd07f9470..4eba94966 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig.ps1 @@ -1,26 +1,33 @@ function Add-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig resource property to the template. Specifies information required when returning a custom HTTP response. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig resource property to the template. - +Specifies information required when returning a custom HTTP response. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html .PARAMETER ContentType + The content type. +Valid Values: text/plain | text/css | text/html | application/javascript | application/json + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-contenttype PrimitiveType: String UpdateType: Mutable .PARAMETER MessageBody + The message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-messagebody PrimitiveType: String UpdateType: Mutable .PARAMETER StatusCode + The HTTP response code 2XX, 4XX, or 5XX. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig.ps1 index 277f772db..6e9371724 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig.ps1 @@ -1,16 +1,19 @@ function Add-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig resource property to the template. Information about a host header condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig resource property to the template. - +Information about a host header condition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html .PARAMETER Values + One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. +If you specify multiple strings, the condition is satisfied if one of the strings matches the host name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-hostheaderconfig-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig.ps1 index 245e69d77..47da52c49 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig.ps1 @@ -1,21 +1,29 @@ function Add-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig resource property to the template. Information about an HTTP header condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig resource property to the template. +Information about an HTTP header condition. +There is a set of standard HTTP header fields. You can also define custom HTTP header fields. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html .PARAMETER HttpHeaderName + The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-httpheadername PrimitiveType: String UpdateType: Mutable .PARAMETER Values + One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. +If the same header appears multiple times in the request, we search them in order until a match is found. +If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig.ps1 index 934dbfa17..9e270fb7b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig.ps1 @@ -1,16 +1,21 @@ function Add-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig resource property to the template. Information about an HTTP method condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig resource property to the template. +Information about an HTTP method condition. +HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry: https://www.iana.org/assignments/http-methods/http-methods.xhtml. You can also define custom HTTP methods. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html .PARAMETER Values + The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen -, and underscore _. The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. +If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html#cfn-elasticloadbalancingv2-listenerrule-httprequestmethodconfig-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRulePathPatternConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRulePathPatternConfig.ps1 index 9394192af..dd9edc7d9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRulePathPatternConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRulePathPatternConfig.ps1 @@ -1,16 +1,19 @@ function Add-VSElasticLoadBalancingV2ListenerRulePathPatternConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig resource property to the template. Information about a path pattern condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig resource property to the template. - +Information about a path pattern condition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html .PARAMETER Values + One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. +If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html#cfn-elasticloadbalancingv2-listenerrule-pathpatternconfig-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig.ps1 index 9fbe9df0a..7a13d0302 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig.ps1 @@ -1,16 +1,21 @@ function Add-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig resource property to the template. Information about a query string condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig resource property to the template. +Information about a query string condition. +The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html .PARAMETER Values + One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character. +If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html#cfn-elasticloadbalancingv2-listenerrule-querystringconfig-values DuplicatesAllowed: False ItemType: QueryStringKeyValue diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue.ps1 index 8d90cc56c..817e21021 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue resource property to the template. Information about a key/value pair. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue resource property to the template. - +Information about a key/value pair. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html .PARAMETER Key + The key. You can omit the key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html#cfn-elasticloadbalancingv2-listenerrule-querystringkeyvalue-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html#cfn-elasticloadbalancingv2-listenerrule-querystringkeyvalue-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRedirectConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRedirectConfig.ps1 index e5caea5cb..c07948a27 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRedirectConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRedirectConfig.ps1 @@ -1,41 +1,69 @@ function Add-VSElasticLoadBalancingV2ListenerRuleRedirectConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig resource property to the template. Information about a redirect action. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig resource property to the template. +Information about a redirect action. +A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. + +You can reuse URI components using the following reserved keywords: + ++ #{protocol} + ++ #{host} + ++ #{port} + ++ #{path} (the leading "/" is removed + ++ #{query} + +For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html .PARAMETER Host + The hostname. This component is not percent-encoded. The hostname can contain #{host}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-host PrimitiveType: String UpdateType: Mutable .PARAMETER Path + The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-path PrimitiveType: String UpdateType: Mutable .PARAMETER Port + The port. You can specify a value from 1 to 65535 or #{port}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-port PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol + The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER Query + The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-query PrimitiveType: String UpdateType: Mutable .PARAMETER StatusCode + The HTTP redirect code. The redirect is either permanent HTTP 301 or temporary HTTP 302. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRuleCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRuleCondition.ps1 index 5f1e86d9e..842d63aee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRuleCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleRuleCondition.ps1 @@ -1,51 +1,88 @@ function Add-VSElasticLoadBalancingV2ListenerRuleRuleCondition { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition resource property to the template. Specifies a condition for a listener rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition resource property to the template. - +Specifies a condition for a listener rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html .PARAMETER Field + The field in the HTTP request. The following are the possible values: ++ http-header ++ http-request-method ++ host-header ++ path-pattern ++ query-string ++ source-ip + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-conditions-field PrimitiveType: String UpdateType: Mutable .PARAMETER HostHeaderConfig + Information for a host header condition. Specify only when Field is host-header. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-hostheaderconfig Type: HostHeaderConfig UpdateType: Mutable .PARAMETER HttpHeaderConfig + Information for an HTTP header condition. Specify only when Field is http-header. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-httpheaderconfig Type: HttpHeaderConfig UpdateType: Mutable .PARAMETER HttpRequestMethodConfig + Information for an HTTP method condition. Specify only when Field is http-request-method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-httprequestmethodconfig Type: HttpRequestMethodConfig UpdateType: Mutable .PARAMETER PathPatternConfig + Information for a path pattern condition. Specify only when Field is path-pattern. +Conditional: Required if HttpHeaderConfig is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-pathpatternconfig Type: PathPatternConfig UpdateType: Mutable .PARAMETER QueryStringConfig + Information for a query string condition. Specify only when Field is query-string. +Conditional: Required if HttpHeaderConfig is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-querystringconfig Type: QueryStringConfig UpdateType: Mutable .PARAMETER SourceIpConfig + Information for a source IP condition. Specify only when Field is source-ip. +Conditional: Required if HttpHeaderConfig is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-sourceipconfig Type: SourceIpConfig UpdateType: Mutable .PARAMETER Values + The condition value. +You can only use Values if the condition type is host-header and path-pattern. You can not specify both Values and HostHeaderConfig at the same time. +If Field is host-header, you can specify a single host name for example, my.example.com. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. ++ A-Z, a-z, 0-9 ++ - . ++ * matches 0 or more characters ++ ? matches exactly 1 character +If Field is path-pattern, you can specify a single path pattern for example, /img/*. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. ++ A-Z, a-z, 0-9 ++ _ - . $ / ~ " ' @ : + ++ & using & ++ * matches 0 or more characters ++ ? matches exactly 1 character + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-conditions-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig.ps1 index bb0ecf120..205c3b68e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig.ps1 @@ -1,16 +1,21 @@ function Add-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig resource property to the template. Information about a source IP condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig resource property to the template. +Information about a source IP condition. +You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html .PARAMETER Values + One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. +If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html#cfn-elasticloadbalancingv2-listenerrule-sourceipconfig-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 index 3c1b2551d..3271c04b6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 @@ -1,21 +1,35 @@ function Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute resource property to the template. Specifies an attribute for an Application Load Balancer or a Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute resource property to the template. - +Specifies an attribute for an Application Load Balancer or a Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html .PARAMETER Key + The name of the attribute. +The following attributes are supported by both Application Load Balancers and Network Load Balancers: ++ access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. ++ access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. ++ access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. ++ deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. +The following attributes are supported by only Application Load Balancers: ++ idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. ++ routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. +The following attributes are supported by only Network Load Balancers: ++ load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of the attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 index c73e0dbb9..9534bf0ae 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping resource property to the template. Specifies a subnet to attach to an Application Load Balancer or a Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping resource property to the template. - +Specifies a subnet to attach to an Application Load Balancer or a Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html .PARAMETER AllocationId + Network Load Balancers] The allocation ID of the Elastic IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-allocationid PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-subnetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupMatcher.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupMatcher.ps1 index 83f45374b..ea392f68a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupMatcher.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupMatcher.ps1 @@ -1,16 +1,20 @@ function Add-VSElasticLoadBalancingV2TargetGroupMatcher { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::TargetGroup.Matcher resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::TargetGroup.Matcher resource property to the template. Specifies the HTTP codes that healthy targets must use when responding to an HTTP health check. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup.Matcher resource property to the template. - +Specifies the HTTP codes that healthy targets must use when responding to an HTTP health check. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html .PARAMETER HttpCode + The HTTP codes. +For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values for example, "200,202" or a range of values for example, "200-299". +For Network Load Balancers, this is 200–399. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html#cfn-elasticloadbalancingv2-targetgroup-matcher-httpcode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 index 96bb9d2a0..588b28cc1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 @@ -1,26 +1,36 @@ function Add-VSElasticLoadBalancingV2TargetGroupTargetDescription { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription resource property to the template. Specifies a target to add to a target group. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription resource property to the template. - +Specifies a target to add to a target group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html .PARAMETER AvailabilityZone + An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. +This parameter is not supported if the target type of the target group is instance. +If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required. +With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all. +If the target type is lambda, this parameter is optional and the only supported value is all. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER Id + The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-id PrimitiveType: String UpdateType: Mutable .PARAMETER Port + The port on which the target is listening. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-port PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 index 103915ac6..5cfb6bd9f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 @@ -1,21 +1,36 @@ function Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute resource property to the template. Specifies a target group attribute. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute resource property to the template. - +Specifies a target group attribute. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html .PARAMETER Key + The name of the attribute. +The following attribute is supported by both Application Load Balancers and Network Load Balancers: ++ deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. +The following attributes are supported by Application Load Balancers if the target is not a Lambda function: ++ slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds 15 minutes. Slow start mode is disabled by default. ++ stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false. ++ stickiness.type - The type of sticky sessions. The possible value is lb_cookie. ++ stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week 604800 seconds. The default value is 1 day 86400 seconds. +The following attribute is supported only if the target is a Lambda function. ++ lambda.multi_value_headers.enabled - Indicates whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. +The following attribute is supported only by Network Load Balancers: ++ proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of the attribute. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEBSOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEBSOptions.ps1 index c4b1dfbd7..0c1e45d15 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEBSOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEBSOptions.ps1 @@ -1,31 +1,39 @@ function Add-VSElasticsearchDomainEBSOptions { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.EBSOptions resource property to the template. + Adds an AWS::Elasticsearch::Domain.EBSOptions resource property to the template. The configurations of Amazon Elastic Block Store (Amazon EBS volumes that are attached to data nodes in the Amazon ES domain. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.EBSOptions resource property to the template. - +The configurations of Amazon Elastic Block Store (Amazon EBS volumes that are attached to data nodes in the Amazon ES domain. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html .PARAMETER EBSEnabled + Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. This property applies only to the Provisioned IOPS SSD EBS volume type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeSize + The size in GiB of the EBS volume for each data node. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1, st1, or sc1. For more information about each type, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 index d7a9a2655..a86f8e254 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 @@ -1,46 +1,60 @@ function Add-VSElasticsearchDomainElasticsearchClusterConfig { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.ElasticsearchClusterConfig resource property to the template. + Adds an AWS::Elasticsearch::Domain.ElasticsearchClusterConfig resource property to the template. The cluster configuration for the Amazon ES domain. You can specify options such as the instance type and the number of instances. For more information, see Configuring Amazon ES Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains-configure-cluster-cli in the *Amazon Elasticsearch Service Developer Guide*. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.ElasticsearchClusterConfig resource property to the template. - +The cluster configuration for the Amazon ES domain. You can specify options such as the instance type and the number of instances. For more information, see Configuring Amazon ES Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains-configure-cluster-cli in the *Amazon Elasticsearch Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html .PARAMETER DedicatedMasterCount + The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount PrimitiveType: Integer UpdateType: Mutable .PARAMETER DedicatedMasterEnabled + Indicates whether to use a dedicated master node for the Amazon ES domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DedicatedMasterType + The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.elasticsearch. If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported Instance Types: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-supported-instance-types.html in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceCount + The number of data nodes instances to use in the Amazon ES domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER InstanceType + The instance type for your data nodes, such as m3.medium.elasticsearch. For valid values, see Supported Instance Types: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-supported-instance-types.html in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype PrimitiveType: String UpdateType: Mutable .PARAMETER ZoneAwarenessConfig + Specifies zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessconfig Type: ZoneAwarenessConfig UpdateType: Mutable .PARAMETER ZoneAwarenessEnabled + Indicates whether to enable zone awareness for the Amazon ES domain. When you enable zone awareness, Amazon ES allocates the nodes and replica index shards that belong to a cluster across two Availability Zones AZs in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Enabling Zone Awareness: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEncryptionAtRestOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEncryptionAtRestOptions.ps1 index 06636bb76..6d5798a2f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEncryptionAtRestOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainEncryptionAtRestOptions.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticsearchDomainEncryptionAtRestOptions { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.EncryptionAtRestOptions resource property to the template. + Adds an AWS::Elasticsearch::Domain.EncryptionAtRestOptions resource property to the template. Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS key to use. Can only be used to create a new domain, not update an existing one. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.EncryptionAtRestOptions resource property to the template. - +Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS key to use. Can only be used to create a new domain, not update an existing one. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html .PARAMETER Enabled + Specify true to enable encryption at rest. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled PrimitiveType: Boolean UpdateType: Immutable .PARAMETER KmsKeyId + The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainNodeToNodeEncryptionOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainNodeToNodeEncryptionOptions.ps1 index 0edb03b15..26b4680dc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainNodeToNodeEncryptionOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainNodeToNodeEncryptionOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticsearchDomainNodeToNodeEncryptionOptions { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions resource property to the template. + Adds an AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions resource property to the template. Specifies whether node-to-node encryption is enabled. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions resource property to the template. - +Specifies whether node-to-node encryption is enabled. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html .PARAMETER Enabled + Specifies whether node-to-node encryption is enabled, as a Boolean. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions-enabled PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainSnapshotOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainSnapshotOptions.ps1 index b921140ac..324ac5188 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainSnapshotOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainSnapshotOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticsearchDomainSnapshotOptions { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.SnapshotOptions resource property to the template. + Adds an AWS::Elasticsearch::Domain.SnapshotOptions resource property to the template. The automated snapshot configuration for the Amazon ES domain indices. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.SnapshotOptions resource property to the template. - +The automated snapshot configuration for the Amazon ES domain indices. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html .PARAMETER AutomatedSnapshotStartHour + The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain. For example, if you specify 0, Amazon ES takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 index 24e70ddf3..3933aa909 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSElasticsearchDomainVPCOptions { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.VPCOptions resource property to the template. + Adds an AWS::Elasticsearch::Domain.VPCOptions resource property to the template. The virtual private cloud (VPC configuration for the Amazon ES domain. For more information, see VPC Support for Amazon Elasticsearch Service Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html in the *Amazon Elasticsearch Service Developer Guide*. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.VPCOptions resource property to the template. - +The virtual private cloud (VPC configuration for the Amazon ES domain. For more information, see VPC Support for Amazon Elasticsearch Service Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html in the *Amazon Elasticsearch Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html .PARAMETER SecurityGroupIds + The list of security group IDs that are associated with the VPC endpoints for the domain. If you don't provide a security group ID, Amazon ES uses the default security group for the VPC. To learn more, see Security Groups for your VPC : https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.htmlin the *Amazon VPC User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSElasticsearchDomainVPCOptions { UpdateType: Mutable .PARAMETER SubnetIds + A list of subnet IDs that are associated with the VPC endpoints for the domain. If your domain has zone awareness enabled, you need to provide two subnet IDs, one per zone. Otherwise, provide only one. To learn more, see VPCs and Subnets: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html in the *Amazon VPC User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 index e3d2e210a..a65fc2f33 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 @@ -1,16 +1,19 @@ function Add-VSElasticsearchDomainZoneAwarenessConfig { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. + Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. Specifies zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. - +Specifies zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html .PARAMETER AvailabilityZoneCount + If you enabled multiple Availability Zones AZs, the number of AZs that you want the domain to use. +Valid values are 2 and 3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsEventBusPolicyCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsEventBusPolicyCondition.ps1 index 5357e9d50..576140fa3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsEventBusPolicyCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsEventBusPolicyCondition.ps1 @@ -1,26 +1,34 @@ function Add-VSEventsEventBusPolicyCondition { <# .SYNOPSIS - Adds an AWS::Events::EventBusPolicy.Condition resource property to the template. + Adds an AWS::Events::EventBusPolicy.Condition resource property to the template. A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. Following is an example value for Condition: .DESCRIPTION Adds an AWS::Events::EventBusPolicy.Condition resource property to the template. +A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. Following is an example value for Condition: +'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}' .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html .PARAMETER Type + Specifies the type of condition. Currently the only supported value is StringEquals. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + Specifies the value for the key. Currently, this must be the ID of the organization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 index 857aaef90..3281b8b78 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSEventsRuleAwsVpcConfiguration { <# .SYNOPSIS - Adds an AWS::Events::Rule.AwsVpcConfiguration resource property to the template. + Adds an AWS::Events::Rule.AwsVpcConfiguration resource property to the template. This structure specifies the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. .DESCRIPTION Adds an AWS::Events::Rule.AwsVpcConfiguration resource property to the template. - +This structure specifies the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html .PARAMETER AssignPublicIp + Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroups + Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you don't specify a security group, the default security group for the VPC is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +27,8 @@ function Add-VSEventsRuleAwsVpcConfiguration { UpdateType: Mutable .PARAMETER Subnets + Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 index e3b9f90a1..6e598dbfa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 @@ -1,41 +1,57 @@ function Add-VSEventsRuleEcsParameters { <# .SYNOPSIS - Adds an AWS::Events::Rule.EcsParameters resource property to the template. + Adds an AWS::Events::Rule.EcsParameters resource property to the template. The EcsParameters property type specifies custom parameters to be used when the target is an Amazon ECS task. .DESCRIPTION Adds an AWS::Events::Rule.EcsParameters resource property to the template. +The EcsParameters property type specifies custom parameters to be used when the target is an Amazon ECS task. +EcsParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html .PARAMETER Group + Specifies an ECS task group for the task. The maximum length is 255 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group PrimitiveType: String UpdateType: Mutable .PARAMETER LaunchType + Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type compatibilities of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkConfiguration + Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. +If you specify NetworkConfiguration when the target ECS task doesn't use the awsvpc network mode, the task fails. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration Type: NetworkConfiguration UpdateType: Mutable .PARAMETER PlatformVersion + Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. +This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion PrimitiveType: String UpdateType: Mutable .PARAMETER TaskCount + The number of tasks to create based on TaskDefinition. The default is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER TaskDefinitionArn + The ARN of the task definition to use. If no task revision is supplied, it defaults to the most recent revision at the time of resource creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 index e4f64b9cc..53e0f6289 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 @@ -1,16 +1,22 @@ function Add-VSEventsRuleInputTransformer { <# .SYNOPSIS - Adds an AWS::Events::Rule.InputTransformer resource property to the template. + Adds an AWS::Events::Rule.InputTransformer resource property to the template. The InputTransformer property type specifies settings that provide custom input to an Amazon CloudWatch Events target based on certain event data. .DESCRIPTION Adds an AWS::Events::Rule.InputTransformer resource property to the template. +The InputTransformer property type specifies settings that provide custom input to an Amazon CloudWatch Events target based on certain event data. +InputTransformer is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html .PARAMETER InputPathsMap + Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target. +InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation. +The keys cannot start with "AWS." + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +24,8 @@ function Add-VSEventsRuleInputTransformer { UpdateType: Mutable .PARAMETER InputTemplate + Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <*value*> The InputTemplate must be valid JSON. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleKinesisParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleKinesisParameters.ps1 index 32dd89598..c72024051 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleKinesisParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleKinesisParameters.ps1 @@ -1,16 +1,22 @@ function Add-VSEventsRuleKinesisParameters { <# .SYNOPSIS - Adds an AWS::Events::Rule.KinesisParameters resource property to the template. + Adds an AWS::Events::Rule.KinesisParameters resource property to the template. The KinesisParameters property type specifies settings that control shard assignment for a Kinesis data stream target. .DESCRIPTION Adds an AWS::Events::Rule.KinesisParameters resource property to the template. +The KinesisParameters property type specifies settings that control shard assignment for a Kinesis data stream target. +KinesisParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. + +This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard that the event goes to. If you don't include this parameter, the default is to use the eventId as the partition key. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html .PARAMETER PartitionKeyPath + The JSON path to be extracted from the event and used as the partition key. For more information, see Partition Key: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key in the *Amazon Kinesis Data Streams Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 index d5a107d72..26a9c8f30 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSEventsRuleNetworkConfiguration { <# .SYNOPSIS - Adds an AWS::Events::Rule.NetworkConfiguration resource property to the template. + Adds an AWS::Events::Rule.NetworkConfiguration resource property to the template. This structure specifies the network configuration for an ECS task. .DESCRIPTION Adds an AWS::Events::Rule.NetworkConfiguration resource property to the template. - +This structure specifies the network configuration for an ECS task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html .PARAMETER AwsVpcConfiguration + Use this structure to specify the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration Type: AwsVpcConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 index 958f3a267..487208eae 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 @@ -1,16 +1,23 @@ function Add-VSEventsRuleRunCommandParameters { <# .SYNOPSIS - Adds an AWS::Events::Rule.RunCommandParameters resource property to the template. + Adds an AWS::Events::Rule.RunCommandParameters resource property to the template. The RunCommandParameters property type specifies the parameters to use when an Amazon CloudWatch Events rule invokes the AWS Systems Manager Run Command. .DESCRIPTION Adds an AWS::Events::Rule.RunCommandParameters resource property to the template. +The RunCommandParameters property type specifies the parameters to use when an Amazon CloudWatch Events rule invokes the AWS Systems Manager Run Command. +RunCommandParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. + +This parameter contains the criteria (either InstanceIds or a tag used to specify which EC2 instances are to be sent the command. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html .PARAMETER RunCommandTargets + The criteria either InstanceIds or a tag that specifies which EC2 instances the command is sent to. +Currently, you can include only one RunCommandTarget block, which specifies a list of InstanceIds or a tag. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets DuplicatesAllowed: False ItemType: RunCommandTarget diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandTarget.ps1 index b5d8bd2e0..2cb6c084f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandTarget.ps1 @@ -1,21 +1,29 @@ function Add-VSEventsRuleRunCommandTarget { <# .SYNOPSIS - Adds an AWS::Events::Rule.RunCommandTarget resource property to the template. + Adds an AWS::Events::Rule.RunCommandTarget resource property to the template. The RunCommandTarget property type specifies information about the Amazon EC2 instances that the Run Command is sent to. A RunCommandTarget block can include only one key, but the key can specify multiple values. .DESCRIPTION Adds an AWS::Events::Rule.RunCommandTarget resource property to the template. +The RunCommandTarget property type specifies information about the Amazon EC2 instances that the Run Command is sent to. A RunCommandTarget block can include only one key, but the key can specify multiple values. +RunCommandTarget is a property of the RunCommandParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html property type. + +Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html .PARAMETER Key + Can be either tag: *tag-key* or InstanceIds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key PrimitiveType: String UpdateType: Mutable .PARAMETER Values + If Key is tag: *tag-key*, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleSqsParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleSqsParameters.ps1 index 40e30f8e7..121c56553 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleSqsParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleSqsParameters.ps1 @@ -1,16 +1,20 @@ function Add-VSEventsRuleSqsParameters { <# .SYNOPSIS - Adds an AWS::Events::Rule.SqsParameters resource property to the template. + Adds an AWS::Events::Rule.SqsParameters resource property to the template. The SqsParameters property type specifies the custom parameter to be used when the target is an Amazon SQS FIFO queue. .DESCRIPTION Adds an AWS::Events::Rule.SqsParameters resource property to the template. +The SqsParameters property type specifies the custom parameter to be used when the target is an Amazon SQS FIFO queue. +SqsParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html .PARAMETER MessageGroupId + The FIFO message group ID to use as the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 index c7acab9c6..bdf8d5bd6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 @@ -1,16 +1,20 @@ function Add-VSEventsRuleTarget { <# .SYNOPSIS - Adds an AWS::Events::Rule.Target resource property to the template. + Adds an AWS::Events::Rule.Target resource property to the template. The Target property type specifies a target, such as an AWS Lambda function or an Amazon Kinesis data stream, that CloudWatch Events invokes when a rule is triggered. .DESCRIPTION Adds an AWS::Events::Rule.Target resource property to the template. +The Target property type specifies a target, such as an AWS Lambda function or an Amazon Kinesis data stream, that CloudWatch Events invokes when a rule is triggered. +Targets property of the AWS::Events::Rule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html resource contains a list of one or more Target property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html .PARAMETER Arn + The Amazon Resource Name ARN of the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn PrimitiveType: String UpdateType: Mutable @@ -21,46 +25,65 @@ function Add-VSEventsRuleTarget { UpdateType: Mutable .PARAMETER EcsParameters + Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions : https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html in the *Amazon EC2 Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters Type: EcsParameters UpdateType: Mutable .PARAMETER Id + The ID of the target. It can include alphanumeric characters, periods ., hyphens -, and underscores _. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id PrimitiveType: String UpdateType: Mutable .PARAMETER Input + Valid JSON text passed to the target. If you use this property, nothing from the event text itself is passed to the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input PrimitiveType: String UpdateType: Mutable .PARAMETER InputPath + When you don't want to pass the entire matched event, InputPath describes which part of the event to pass to the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath PrimitiveType: String UpdateType: Mutable .PARAMETER InputTransformer + Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer Type: InputTransformer UpdateType: Mutable .PARAMETER KinesisParameters + The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters Type: KinesisParameters UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER RunCommandParameters + Parameters used when you are using the rule to invoke Amazon EC2 Run Command. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters Type: RunCommandParameters UpdateType: Mutable .PARAMETER SqsParameters + Contains the message group ID to use when the target is a FIFO queue. +If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters Type: SqsParameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 index 79d602b57..a9f4d21d0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 @@ -1,41 +1,55 @@ function Add-VSFSxFileSystemLustreConfiguration { <# .SYNOPSIS - Adds an AWS::FSx::FileSystem.LustreConfiguration resource property to the template. + Adds an AWS::FSx::FileSystem.LustreConfiguration resource property to the template. The configuration for the Amazon FSx for Lustre file system. .DESCRIPTION Adds an AWS::FSx::FileSystem.LustreConfiguration resource property to the template. - +The configuration for the Amazon FSx for Lustre file system. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html .PARAMETER ImportPath + The path to the Amazon S3 bucket including the optional prefix that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importpath PrimitiveType: String UpdateType: Immutable .PARAMETER WeeklyMaintenanceStartTime + The preferred time to perform weekly maintenance, in the UTC time zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-weeklymaintenancestarttime PrimitiveType: String UpdateType: Mutable .PARAMETER ImportedFileChunkSize + For files imported from a data repository, this value determines the stripe count and maximum amount of data per file in MiB stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. +The chunk size default is 1,024 MiB 1 GiB and can go as high as 512,000 MiB 500 GiB. Amazon S3 objects have a maximum size of 5 TB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importedfilechunksize PrimitiveType: Integer UpdateType: Immutable .PARAMETER DeploymentType + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-deploymenttype PrimitiveType: String UpdateType: Immutable .PARAMETER ExportPath + The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustrecreation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z. +The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-exportpath PrimitiveType: String UpdateType: Immutable .PARAMETER PerUnitStorageThroughput + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-perunitstoragethroughput PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 index 5cf1c5e2c..2f7bc79e1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 @@ -1,56 +1,74 @@ function Add-VSFSxFileSystemWindowsConfiguration { <# .SYNOPSIS - Adds an AWS::FSx::FileSystem.WindowsConfiguration resource property to the template. + Adds an AWS::FSx::FileSystem.WindowsConfiguration resource property to the template. The configuration for this Microsoft Windows file system. .DESCRIPTION Adds an AWS::FSx::FileSystem.WindowsConfiguration resource property to the template. - +The configuration for this Microsoft Windows file system. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html .PARAMETER SelfManagedActiveDirectoryConfiguration + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: SelfManagedActiveDirectoryConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration UpdateType: Mutable .PARAMETER WeeklyMaintenanceStartTime + The preferred start time to perform weekly maintenance, in the UTC time zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-weeklymaintenancestarttime PrimitiveType: String UpdateType: Mutable .PARAMETER ActiveDirectoryId + The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-activedirectoryid PrimitiveType: String UpdateType: Immutable .PARAMETER DeploymentType + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-deploymenttype PrimitiveType: String UpdateType: Immutable .PARAMETER ThroughputCapacity + The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 8 and 2^11 2048. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-throughputcapacity PrimitiveType: Integer UpdateType: Immutable .PARAMETER CopyTagsToBackups + A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-copytagstobackups PrimitiveType: Boolean UpdateType: Immutable .PARAMETER DailyAutomaticBackupStartTime + The preferred time to take daily automatic backups, in the UTC time zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-dailyautomaticbackupstarttime PrimitiveType: String UpdateType: Mutable .PARAMETER AutomaticBackupRetentionDays + The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-automaticbackupretentiondays PrimitiveType: Integer UpdateType: Mutable .PARAMETER PreferredSubnetId + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-preferredsubnetid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 index 685e892e8..bb81b8883 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 @@ -1,26 +1,37 @@ function Add-VSGameLiftAliasRoutingStrategy { <# .SYNOPSIS - Adds an AWS::GameLift::Alias.RoutingStrategy resource property to the template. + Adds an AWS::GameLift::Alias.RoutingStrategy resource property to the template. Routing configuration for a fleet alias. .DESCRIPTION Adds an AWS::GameLift::Alias.RoutingStrategy resource property to the template. - +Routing configuration for a fleet alias. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html .PARAMETER FleetId + Unique identifier for a fleet that the alias points to. +*Required:* Conditional. If you specify SIMPLE for the Type property, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid PrimitiveType: String UpdateType: Mutable .PARAMETER Message + Message text to be used with a terminal routing strategy. +*Required:* Conditional. If you specify TERMINAL for the Type property, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message PrimitiveType: String UpdateType: Mutable .PARAMETER Type + Type of routing strategy. +Possible routing types include the following: ++ **SIMPLE** -- The alias resolves to one specific fleet. Use this type when routing to active fleets. ++ **TERMINAL** -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message that you specified in the Message property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 index 2fe0a2022..c1edb46e0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 @@ -1,31 +1,39 @@ function Add-VSGameLiftBuildS3Location { <# .SYNOPSIS - Adds an AWS::GameLift::Build.S3Location resource property to the template. + Adds an AWS::GameLift::Build.S3Location resource property to the template. Location in Amazon Simple Storage Service (Amazon S3 where build files can be stored for access by Amazon GameLift. For more details, see the Uploading a Build to Amazon GameLift: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html in the *Amazon GameLift Developer Guide*. .DESCRIPTION Adds an AWS::GameLift::Build.S3Location resource property to the template. - +Location in Amazon Simple Storage Service (Amazon S3 where build files can be stored for access by Amazon GameLift. For more details, see the Uploading a Build to Amazon GameLift: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html in the *Amazon GameLift Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html .PARAMETER Bucket + Amazon S3 bucket identifier. This is the name of the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-bucket PrimitiveType: String UpdateType: Immutable .PARAMETER Key + Name of the zip file containing the build files or script files. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-key PrimitiveType: String UpdateType: Immutable .PARAMETER ObjectVersion + + S3Location: https://docs.aws.amazon.com/gamelift/latest/apireference/API_S3Location.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-object-verison PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn + Amazon Resource Name ARN: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html for an IAM role that allows Amazon GameLift to access the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-rolearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 index 34c78da09..3c6b62e19 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 @@ -1,31 +1,39 @@ function Add-VSGameLiftFleetIpPermission { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet.IpPermission resource property to the template. + Adds an AWS::GameLift::Fleet.IpPermission resource property to the template. A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers. .DESCRIPTION Adds an AWS::GameLift::Fleet.IpPermission resource property to the template. - +A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html .PARAMETER FromPort + Starting value for a range of allowed port numbers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-fromport PrimitiveType: Integer UpdateType: Mutable .PARAMETER IpRange + Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/subnet mask]" or optionally the shortened version "0.0.0.0/subnet mask]". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-iprange PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol + Network communication protocol used by the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER ToPort + Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-toport PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierCsvClassifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierCsvClassifier.ps1 index 6f3c11e43..914da7293 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierCsvClassifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierCsvClassifier.ps1 @@ -1,47 +1,61 @@ function Add-VSGlueClassifierCsvClassifier { <# .SYNOPSIS - Adds an AWS::Glue::Classifier.CsvClassifier resource property to the template. + Adds an AWS::Glue::Classifier.CsvClassifier resource property to the template. A classifier for custom CSV content. .DESCRIPTION Adds an AWS::Glue::Classifier.CsvClassifier resource property to the template. - +A classifier for custom CSV content. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html .PARAMETER QuoteSymbol + A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-quotesymbol PrimitiveType: String UpdateType: Mutable .PARAMETER ContainsHeader + Indicates whether the CSV file contains a header. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-containsheader PrimitiveType: String UpdateType: Mutable .PARAMETER Delimiter + A custom symbol to denote what separates each column entry in the row. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-delimiter PrimitiveType: String UpdateType: Mutable .PARAMETER Header + A list of strings representing column names. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-header UpdateType: Mutable .PARAMETER AllowSingleColumn + Enables the processing of files that contain only one column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-allowsinglecolumn PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DisableValueTrimming + Specifies not to trim values before identifying the type of column values. The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-disablevaluetrimming PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The name of the classifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierGrokClassifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierGrokClassifier.ps1 index 1d4bbe467..8cd6c9ccb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierGrokClassifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierGrokClassifier.ps1 @@ -1,31 +1,39 @@ function Add-VSGlueClassifierGrokClassifier { <# .SYNOPSIS - Adds an AWS::Glue::Classifier.GrokClassifier resource property to the template. + Adds an AWS::Glue::Classifier.GrokClassifier resource property to the template. A classifier that uses grok patterns. .DESCRIPTION Adds an AWS::Glue::Classifier.GrokClassifier resource property to the template. - +A classifier that uses grok patterns. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html .PARAMETER CustomPatterns + Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-custompatterns PrimitiveType: String UpdateType: Mutable .PARAMETER GrokPattern + The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-grokpattern PrimitiveType: String UpdateType: Mutable .PARAMETER Classification + An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-classification PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the classifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierJsonClassifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierJsonClassifier.ps1 index eb99c3205..17126231e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierJsonClassifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierJsonClassifier.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueClassifierJsonClassifier { <# .SYNOPSIS - Adds an AWS::Glue::Classifier.JsonClassifier resource property to the template. + Adds an AWS::Glue::Classifier.JsonClassifier resource property to the template. A classifier for JSON content. .DESCRIPTION Adds an AWS::Glue::Classifier.JsonClassifier resource property to the template. - +A classifier for JSON content. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html .PARAMETER JsonPath + A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-jsonpath PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the classifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierXMLClassifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierXMLClassifier.ps1 index a3fb0feb2..a0877f681 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierXMLClassifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueClassifierXMLClassifier.ps1 @@ -1,26 +1,32 @@ function Add-VSGlueClassifierXMLClassifier { <# .SYNOPSIS - Adds an AWS::Glue::Classifier.XMLClassifier resource property to the template. + Adds an AWS::Glue::Classifier.XMLClassifier resource property to the template. A classifier for XML content. .DESCRIPTION Adds an AWS::Glue::Classifier.XMLClassifier resource property to the template. - +A classifier for XML content. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html .PARAMETER RowTag + The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element closed by />. An empty row element that contains only attributes can be parsed as long as it ends with a closing tag for example, is okay, but is not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-rowtag PrimitiveType: String UpdateType: Mutable .PARAMETER Classification + An identifier of the data format that the classifier matches. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-classification PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the classifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionConnectionInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionConnectionInput.ps1 index d070229e4..5f0ac747b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionConnectionInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionConnectionInput.ps1 @@ -1,42 +1,54 @@ function Add-VSGlueConnectionConnectionInput { <# .SYNOPSIS - Adds an AWS::Glue::Connection.ConnectionInput resource property to the template. + Adds an AWS::Glue::Connection.ConnectionInput resource property to the template. A structure that is used to specify a connection to create or update. .DESCRIPTION Adds an AWS::Glue::Connection.ConnectionInput resource property to the template. - +A structure that is used to specify a connection to create or update. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html .PARAMETER Description + The description of the connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description PrimitiveType: String UpdateType: Mutable .PARAMETER ConnectionType + The type of the connection. Currently, only JDBC is supported; SFTP is not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype PrimitiveType: String UpdateType: Mutable .PARAMETER MatchCriteria + A list of criteria that can be used in selecting this connection. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria UpdateType: Mutable .PARAMETER PhysicalConnectionRequirements + A map of physical connection requirements, such as virtual private cloud VPC and SecurityGroup, that are needed to successfully make this connection. + Type: PhysicalConnectionRequirements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements UpdateType: Mutable .PARAMETER ConnectionProperties + These key-value pairs define parameters for the connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionPhysicalConnectionRequirements.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionPhysicalConnectionRequirements.ps1 index 9173e029d..a76e9ecfc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionPhysicalConnectionRequirements.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueConnectionPhysicalConnectionRequirements.ps1 @@ -1,27 +1,33 @@ function Add-VSGlueConnectionPhysicalConnectionRequirements { <# .SYNOPSIS - Adds an AWS::Glue::Connection.PhysicalConnectionRequirements resource property to the template. + Adds an AWS::Glue::Connection.PhysicalConnectionRequirements resource property to the template. Specifies the physical requirements for a connection. .DESCRIPTION Adds an AWS::Glue::Connection.PhysicalConnectionRequirements resource property to the template. - +Specifies the physical requirements for a connection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html .PARAMETER AvailabilityZone + The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroupIdList + The security group ID list used by the connection. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-securitygroupidlist UpdateType: Mutable .PARAMETER SubnetId + The subnet ID used by the connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-subnetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerJdbcTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerJdbcTarget.ps1 index aff2fb983..eaeecf131 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerJdbcTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerJdbcTarget.ps1 @@ -1,26 +1,32 @@ function Add-VSGlueCrawlerJdbcTarget { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.JdbcTarget resource property to the template. + Adds an AWS::Glue::Crawler.JdbcTarget resource property to the template. Specifies a JDBC data store to crawl. .DESCRIPTION Adds an AWS::Glue::Crawler.JdbcTarget resource property to the template. - +Specifies a JDBC data store to crawl. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html .PARAMETER ConnectionName + The name of the connection to use to connect to the JDBC target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-connectionname PrimitiveType: String UpdateType: Mutable .PARAMETER Path + The path of the JDBC target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-path PrimitiveType: String UpdateType: Mutable .PARAMETER Exclusions + A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-exclusions diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerS3Target.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerS3Target.ps1 index 62ded1622..bdd64cf89 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerS3Target.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerS3Target.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueCrawlerS3Target { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.S3Target resource property to the template. + Adds an AWS::Glue::Crawler.S3Target resource property to the template. Specifies a data store in Amazon Simple Storage Service (Amazon S3. .DESCRIPTION Adds an AWS::Glue::Crawler.S3Target resource property to the template. - +Specifies a data store in Amazon Simple Storage Service (Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html .PARAMETER Path + The path to the Amazon S3 target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path PrimitiveType: String UpdateType: Mutable .PARAMETER Exclusions + A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchedule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchedule.ps1 index 3e8f9b7bc..9db565ba7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchedule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchedule.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueCrawlerSchedule { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.Schedule resource property to the template. + Adds an AWS::Glue::Crawler.Schedule resource property to the template. A scheduling object using a cron statement to schedule an event. .DESCRIPTION Adds an AWS::Glue::Crawler.Schedule resource property to the template. - +A scheduling object using a cron statement to schedule an event. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html .PARAMETER ScheduleExpression + A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html. For example, to run something every day at 12:15 UTC, specify cron15 12 * * ? *. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html#cfn-glue-crawler-schedule-scheduleexpression PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchemaChangePolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchemaChangePolicy.ps1 index c50c7d9c0..b6c6d6711 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchemaChangePolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerSchemaChangePolicy.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueCrawlerSchemaChangePolicy { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.SchemaChangePolicy resource property to the template. + Adds an AWS::Glue::Crawler.SchemaChangePolicy resource property to the template. A policy that specifies update and deletion behaviors for the crawler. .DESCRIPTION Adds an AWS::Glue::Crawler.SchemaChangePolicy resource property to the template. - +A policy that specifies update and deletion behaviors for the crawler. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html .PARAMETER UpdateBehavior + The update behavior when the crawler finds a changed schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-updatebehavior PrimitiveType: String UpdateType: Mutable .PARAMETER DeleteBehavior + The deletion behavior when the crawler finds a deleted object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-deletebehavior PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 index 9ef6b4781..7a4797c30 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 @@ -1,34 +1,42 @@ function Add-VSGlueCrawlerTargets { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.Targets resource property to the template. + Adds an AWS::Glue::Crawler.Targets resource property to the template. Specifies data stores to crawl. .DESCRIPTION Adds an AWS::Glue::Crawler.Targets resource property to the template. - +Specifies data stores to crawl. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html .PARAMETER S3Targets + Specifies Amazon Simple Storage Service Amazon S3 targets. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-s3targets ItemType: S3Target UpdateType: Mutable .PARAMETER CatalogTargets + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-catalogtargets ItemType: CatalogTarget UpdateType: Mutable .PARAMETER JdbcTargets + Specifies JDBC targets. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-jdbctargets ItemType: JdbcTarget UpdateType: Mutable .PARAMETER DynamoDBTargets + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-dynamodbtargets ItemType: DynamoDBTarget diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsConnectionPasswordEncryption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsConnectionPasswordEncryption.ps1 index 63bec5a4f..64a12ea98 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsConnectionPasswordEncryption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsConnectionPasswordEncryption.ps1 @@ -1,21 +1,30 @@ function Add-VSGlueDataCatalogEncryptionSettingsConnectionPasswordEncryption { <# .SYNOPSIS - Adds an AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption resource property to the template. + Adds an AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption resource property to the template. The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption. .DESCRIPTION Adds an AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption resource property to the template. +The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption. +When a CreationConnection request arrives containing a password, the Data Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled. + +This encryption requires that you set AWS KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html .PARAMETER ReturnConnectionPasswordEncrypted + When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html#cfn-glue-datacatalogencryptionsettings-connectionpasswordencryption-returnconnectionpasswordencrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER KmsKeyId + An AWS KMS key that is used to encrypt the connection password. +If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog. You can set the decrypt permission to enable or restrict access on the password key according to your security requirements. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html#cfn-glue-datacatalogencryptionsettings-connectionpasswordencryption-kmskeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsDataCatalogEncryptionSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsDataCatalogEncryptionSettings.ps1 index 769431e8f..8f7e71099 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsDataCatalogEncryptionSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsDataCatalogEncryptionSettings.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueDataCatalogEncryptionSettingsDataCatalogEncryptionSettings { <# .SYNOPSIS - Adds an AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings resource property to the template. + Adds an AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings resource property to the template. Contains configuration information for maintaining Data Catalog security. .DESCRIPTION Adds an AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings resource property to the template. - +Contains configuration information for maintaining Data Catalog security. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html .PARAMETER ConnectionPasswordEncryption + When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption. + Type: ConnectionPasswordEncryption Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings-connectionpasswordencryption UpdateType: Mutable .PARAMETER EncryptionAtRest + Specifies the encryption-at-rest configuration for the Data Catalog. + Type: EncryptionAtRest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings-encryptionatrest UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsEncryptionAtRest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsEncryptionAtRest.ps1 index 1dcf69833..1ccb96272 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsEncryptionAtRest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueDataCatalogEncryptionSettingsEncryptionAtRest.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueDataCatalogEncryptionSettingsEncryptionAtRest { <# .SYNOPSIS - Adds an AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest resource property to the template. + Adds an AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest resource property to the template. Specifies the encryption-at-rest configuration for the Data Catalog. .DESCRIPTION Adds an AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest resource property to the template. - +Specifies the encryption-at-rest configuration for the Data Catalog. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html .PARAMETER CatalogEncryptionMode + The encryption-at-rest mode for encrypting Data Catalog data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-catalogencryptionmode PrimitiveType: String UpdateType: Mutable .PARAMETER SseAwsKmsKeyId + The ID of the AWS KMS key to use for encryption at rest. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-sseawskmskeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 index be466bfc1..c027ddd21 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 @@ -1,31 +1,40 @@ function Add-VSGlueDatabaseDatabaseInput { <# .SYNOPSIS - Adds an AWS::Glue::Database.DatabaseInput resource property to the template. + Adds an AWS::Glue::Database.DatabaseInput resource property to the template. The structure used to create or update a database. .DESCRIPTION Adds an AWS::Glue::Database.DatabaseInput resource property to the template. - +The structure used to create or update a database. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html .PARAMETER LocationUri + The location of the database for example, an HDFS path. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-locationuri PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-description PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + These key-value pairs define parameters and properties of the database. +These key-value pairs define parameters and properties of the database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the database. For Hive compatibility, this is folded to lowercase when it is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueJobConnectionsList.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueJobConnectionsList.ps1 index d404ba3c7..057a3e69c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueJobConnectionsList.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueJobConnectionsList.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueJobConnectionsList { <# .SYNOPSIS - Adds an AWS::Glue::Job.ConnectionsList resource property to the template. + Adds an AWS::Glue::Job.ConnectionsList resource property to the template. Specifies the connections used by a job. .DESCRIPTION Adds an AWS::Glue::Job.ConnectionsList resource property to the template. - +Specifies the connections used by a job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html .PARAMETER Connections + A list of connections used by the job. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html#cfn-glue-job-connectionslist-connections diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueJobExecutionProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueJobExecutionProperty.ps1 index 00c239d56..f9a0738b3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueJobExecutionProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueJobExecutionProperty.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueJobExecutionProperty { <# .SYNOPSIS - Adds an AWS::Glue::Job.ExecutionProperty resource property to the template. + Adds an AWS::Glue::Job.ExecutionProperty resource property to the template. An execution property of a job. .DESCRIPTION Adds an AWS::Glue::Job.ExecutionProperty resource property to the template. - +An execution property of a job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html .PARAMETER MaxConcurrentRuns + The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html#cfn-glue-job-executionproperty-maxconcurrentruns PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueJobJobCommand.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueJobJobCommand.ps1 index edd05c412..14b704524 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueJobJobCommand.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueJobJobCommand.ps1 @@ -1,26 +1,32 @@ function Add-VSGlueJobJobCommand { <# .SYNOPSIS - Adds an AWS::Glue::Job.JobCommand resource property to the template. + Adds an AWS::Glue::Job.JobCommand resource property to the template. Specifies code executed when a job is run. .DESCRIPTION Adds an AWS::Glue::Job.JobCommand resource property to the template. - +Specifies code executed when a job is run. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html .PARAMETER PythonVersion + The Python version being used to execute a Python shell job. Allowed values are 2 or 3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-pythonversion PrimitiveType: String UpdateType: Mutable .PARAMETER ScriptLocation + Specifies the Amazon Simple Storage Service Amazon S3 path to a script that executes a job required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-scriptlocation PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell job, it must be pythonshell. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformFindMatchesParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformFindMatchesParameters.ps1 index 382a20833..6bf7f5abf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformFindMatchesParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformFindMatchesParameters.ps1 @@ -1,31 +1,44 @@ function Add-VSGlueMLTransformFindMatchesParameters { <# .SYNOPSIS - Adds an AWS::Glue::MLTransform.FindMatchesParameters resource property to the template. + Adds an AWS::Glue::MLTransform.FindMatchesParameters resource property to the template. The parameters to configure the find matches transform. .DESCRIPTION Adds an AWS::Glue::MLTransform.FindMatchesParameters resource property to the template. - +The parameters to configure the find matches transform. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html .PARAMETER PrecisionRecallTradeoff + The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision. +The precision metric indicates how often your model is correct when it predicts a match. +The recall metric indicates that for an actual match, how often your model predicts the match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-precisionrecalltradeoff PrimitiveType: Double UpdateType: Mutable .PARAMETER EnforceProvidedLabels + The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model. +Note that setting this value to true may increase the conflation execution time. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-enforceprovidedlabels PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PrimaryKeyColumnName + The name of a column that uniquely identifies rows in the source table. Used to help identify matching records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-primarykeycolumnname PrimitiveType: String UpdateType: Immutable .PARAMETER AccuracyCostTradeoff + The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy. +Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall. +Cost measures how many compute resources, and thus money, are consumed to run the transform. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-accuracycosttradeoff PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformGlueTables.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformGlueTables.ps1 index cddda754b..137f02b91 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformGlueTables.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformGlueTables.ps1 @@ -1,31 +1,39 @@ function Add-VSGlueMLTransformGlueTables { <# .SYNOPSIS - Adds an AWS::Glue::MLTransform.GlueTables resource property to the template. + Adds an AWS::Glue::MLTransform.GlueTables resource property to the template. The database and table in the AWS Glue Data Catalog that is used for input or output data. .DESCRIPTION Adds an AWS::Glue::MLTransform.GlueTables resource property to the template. - +The database and table in the AWS Glue Data Catalog that is used for input or output data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html .PARAMETER ConnectionName + The name of the connection to the AWS Glue Data Catalog. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-connectionname PrimitiveType: String UpdateType: Mutable .PARAMETER TableName + A table name in the AWS Glue Data Catalog. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName + A database name in the AWS Glue Data Catalog. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER CatalogId + A unique identifier for the AWS Glue Data Catalog. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-catalogid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformInputRecordTables.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformInputRecordTables.ps1 index dde28854a..aea1f7637 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformInputRecordTables.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformInputRecordTables.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueMLTransformInputRecordTables { <# .SYNOPSIS - Adds an AWS::Glue::MLTransform.InputRecordTables resource property to the template. + Adds an AWS::Glue::MLTransform.InputRecordTables resource property to the template. A list of AWS Glue table definitions used by the transform. .DESCRIPTION Adds an AWS::Glue::MLTransform.InputRecordTables resource property to the template. - +A list of AWS Glue table definitions used by the transform. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables.html .PARAMETER GlueTables + The database and table in the AWS Glue Data Catalog that is used for input or output data. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables.html#cfn-glue-mltransform-inputrecordtables-gluetables ItemType: GlueTables diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformTransformParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformTransformParameters.ps1 index f62fbaeb3..3762227ff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformTransformParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueMLTransformTransformParameters.ps1 @@ -1,21 +1,26 @@ function Add-VSGlueMLTransformTransformParameters { <# .SYNOPSIS - Adds an AWS::Glue::MLTransform.TransformParameters resource property to the template. + Adds an AWS::Glue::MLTransform.TransformParameters resource property to the template. The algorithm-specific parameters that are associated with the machine learning transform. .DESCRIPTION Adds an AWS::Glue::MLTransform.TransformParameters resource property to the template. - +The algorithm-specific parameters that are associated with the machine learning transform. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html .PARAMETER TransformType + The type of machine learning transform. FIND_MATCHES is the only option. +For information about the types of machine learning transforms, see Creating Machine Learning Transforms: https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html#cfn-glue-mltransform-transformparameters-transformtype PrimitiveType: String UpdateType: Mutable .PARAMETER FindMatchesParameters + The parameters for the find matches algorithm. + Type: FindMatchesParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionColumn.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionColumn.ps1 index 865021a20..8f266e373 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionColumn.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionColumn.ps1 @@ -1,26 +1,32 @@ function Add-VSGluePartitionColumn { <# .SYNOPSIS - Adds an AWS::Glue::Partition.Column resource property to the template. + Adds an AWS::Glue::Partition.Column resource property to the template. A column in a Table. .DESCRIPTION Adds an AWS::Glue::Partition.Column resource property to the template. - +A column in a Table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html .PARAMETER Comment + A free-form text comment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-comment PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The data type of the Column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-type PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the Column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionOrder.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionOrder.ps1 index 26d9ebe4b..73e9f88ba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionOrder.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionOrder.ps1 @@ -1,21 +1,25 @@ function Add-VSGluePartitionOrder { <# .SYNOPSIS - Adds an AWS::Glue::Partition.Order resource property to the template. + Adds an AWS::Glue::Partition.Order resource property to the template. Specifies the sort order of a sorted column. .DESCRIPTION Adds an AWS::Glue::Partition.Order resource property to the template. - +Specifies the sort order of a sorted column. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html .PARAMETER Column + The name of the column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-column PrimitiveType: String UpdateType: Mutable .PARAMETER SortOrder + Indicates that the column is sorted in ascending order == 1, or in descending order ==0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-sortorder PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 index e798667e0..95328af7e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 @@ -1,26 +1,32 @@ function Add-VSGluePartitionPartitionInput { <# .SYNOPSIS - Adds an AWS::Glue::Partition.PartitionInput resource property to the template. + Adds an AWS::Glue::Partition.PartitionInput resource property to the template. The structure used to create and update a partition. .DESCRIPTION Adds an AWS::Glue::Partition.PartitionInput resource property to the template. - +The structure used to create and update a partition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html .PARAMETER Parameters + These key-value pairs define partition parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER StorageDescriptor + Provides information about the physical location where the partition is stored. + Type: StorageDescriptor Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-storagedescriptor UpdateType: Mutable .PARAMETER Values + The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-values diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSerdeInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSerdeInfo.ps1 index 1be75c87d..c0ff0cba7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSerdeInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSerdeInfo.ps1 @@ -1,26 +1,32 @@ function Add-VSGluePartitionSerdeInfo { <# .SYNOPSIS - Adds an AWS::Glue::Partition.SerdeInfo resource property to the template. + Adds an AWS::Glue::Partition.SerdeInfo resource property to the template. Information about a serialization/deserialization program (SerDe that serves as an extractor and loader. .DESCRIPTION Adds an AWS::Glue::Partition.SerdeInfo resource property to the template. - +Information about a serialization/deserialization program (SerDe that serves as an extractor and loader. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html .PARAMETER Parameters + These key-value pairs define initialization parameters for the SerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER SerializationLibrary + Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-serializationlibrary PrimitiveType: String UpdateType: Mutable .PARAMETER Name + Name of the SerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSkewedInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSkewedInfo.ps1 index a6d11a760..f1da00fd5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSkewedInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionSkewedInfo.ps1 @@ -1,28 +1,34 @@ function Add-VSGluePartitionSkewedInfo { <# .SYNOPSIS - Adds an AWS::Glue::Partition.SkewedInfo resource property to the template. + Adds an AWS::Glue::Partition.SkewedInfo resource property to the template. Specifies skewed values in a table. Skewed values are those that occur with very high frequency. .DESCRIPTION Adds an AWS::Glue::Partition.SkewedInfo resource property to the template. - +Specifies skewed values in a table. Skewed values are those that occur with very high frequency. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html .PARAMETER SkewedColumnNames + A list of names of columns that contain skewed values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnnames UpdateType: Mutable .PARAMETER SkewedColumnValues + A list of values that appear so frequently as to be considered skewed. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvalues UpdateType: Mutable .PARAMETER SkewedColumnValueLocationMaps + A mapping of skewed values to the columns that contain them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvaluelocationmaps PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionStorageDescriptor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionStorageDescriptor.ps1 index 3d39ef2aa..7120b00e7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionStorageDescriptor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionStorageDescriptor.ps1 @@ -1,74 +1,99 @@ function Add-VSGluePartitionStorageDescriptor { <# .SYNOPSIS - Adds an AWS::Glue::Partition.StorageDescriptor resource property to the template. + Adds an AWS::Glue::Partition.StorageDescriptor resource property to the template. Describes the physical storage of table data. .DESCRIPTION Adds an AWS::Glue::Partition.StorageDescriptor resource property to the template. - +Describes the physical storage of table data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html .PARAMETER StoredAsSubDirectories + True if the table data is stored in subdirectories, or False if not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-storedassubdirectories PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Parameters + The user-supplied properties in key-value form. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER BucketColumns + A list of reducer grouping columns, clustering columns, and bucketing columns in the table. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-bucketcolumns UpdateType: Mutable .PARAMETER SkewedInfo + The information about values that appear frequently in a column skewed values. + Type: SkewedInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-skewedinfo UpdateType: Mutable .PARAMETER InputFormat + The input format: SequenceFileInputFormat binary, or TextInputFormat, or a custom format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-inputformat PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfBuckets + The number of buckets. +You must specify this property if the partition contains any dimension columns. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-numberofbuckets PrimitiveType: Integer UpdateType: Mutable .PARAMETER OutputFormat + The output format: SequenceFileOutputFormat binary, or IgnoreKeyTextOutputFormat, or a custom format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-outputformat PrimitiveType: String UpdateType: Mutable .PARAMETER Columns + A list of the Columns in the table. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-columns ItemType: Column UpdateType: Mutable .PARAMETER SerdeInfo + The serialization/deserialization SerDe information. + Type: SerdeInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-serdeinfo UpdateType: Mutable .PARAMETER SortColumns + A list specifying the sort order of each bucket in the table. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-sortcolumns ItemType: Order UpdateType: Mutable .PARAMETER Compressed + True if the data in the table is compressed, or False if not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-compressed PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Location + The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationCloudWatchEncryption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationCloudWatchEncryption.ps1 index 088f5cc3f..95d2062d4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationCloudWatchEncryption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationCloudWatchEncryption.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueSecurityConfigurationCloudWatchEncryption { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration.CloudWatchEncryption resource property to the template. + Adds an AWS::Glue::SecurityConfiguration.CloudWatchEncryption resource property to the template. Specifies how Amazon CloudWatch data should be encrypted. .DESCRIPTION Adds an AWS::Glue::SecurityConfiguration.CloudWatchEncryption resource property to the template. - +Specifies how Amazon CloudWatch data should be encrypted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html .PARAMETER KmsKeyArn + The Amazon Resource Name ARN of the KMS key to be used to encrypt the data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-kmskeyarn PrimitiveType: String UpdateType: Mutable .PARAMETER CloudWatchEncryptionMode + The encryption mode to use for CloudWatch data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-cloudwatchencryptionmode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationEncryptionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationEncryptionConfiguration.ps1 index afcb14e91..e2f5e0aa4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationEncryptionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationEncryptionConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSGlueSecurityConfigurationEncryptionConfiguration { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration.EncryptionConfiguration resource property to the template. + Adds an AWS::Glue::SecurityConfiguration.EncryptionConfiguration resource property to the template. Specifies an encryption configuration. .DESCRIPTION Adds an AWS::Glue::SecurityConfiguration.EncryptionConfiguration resource property to the template. - +Specifies an encryption configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html .PARAMETER S3Encryptions + The encyption configuration for Amazon Simple Storage Service Amazon S3 data. + Type: S3Encryptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-s3encryptions UpdateType: Mutable .PARAMETER CloudWatchEncryption + The encryption configuration for Amazon CloudWatch. + Type: CloudWatchEncryption Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-cloudwatchencryption UpdateType: Mutable .PARAMETER JobBookmarksEncryption + The encryption configuration for job bookmarks. + Type: JobBookmarksEncryption Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-jobbookmarksencryption UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationJobBookmarksEncryption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationJobBookmarksEncryption.ps1 index 64a0301b4..e56c3da6a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationJobBookmarksEncryption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationJobBookmarksEncryption.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueSecurityConfigurationJobBookmarksEncryption { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration.JobBookmarksEncryption resource property to the template. + Adds an AWS::Glue::SecurityConfiguration.JobBookmarksEncryption resource property to the template. Specifies how job bookmark data should be encrypted. .DESCRIPTION Adds an AWS::Glue::SecurityConfiguration.JobBookmarksEncryption resource property to the template. - +Specifies how job bookmark data should be encrypted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html .PARAMETER KmsKeyArn + The Amazon Resource Name ARN of the KMS key to be used to encrypt the data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-kmskeyarn PrimitiveType: String UpdateType: Mutable .PARAMETER JobBookmarksEncryptionMode + The encryption mode to use for job bookmarks data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-jobbookmarksencryptionmode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryption.ps1 index f3a2a3b8a..7146d72e8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryption.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueSecurityConfigurationS3Encryption { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration.S3Encryption resource property to the template. + Adds an AWS::Glue::SecurityConfiguration.S3Encryption resource property to the template. Specifies how Amazon Simple Storage Service (Amazon S3 data should be encrypted. .DESCRIPTION Adds an AWS::Glue::SecurityConfiguration.S3Encryption resource property to the template. - +Specifies how Amazon Simple Storage Service (Amazon S3 data should be encrypted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html .PARAMETER KmsKeyArn + The Amazon Resource Name ARN of the KMS key to be used to encrypt the data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-kmskeyarn PrimitiveType: String UpdateType: Mutable .PARAMETER S3EncryptionMode + The encryption mode to use for Amazon S3 data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-s3encryptionmode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 index d78db8fa4..51765f7cc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 @@ -1,11 +1,17 @@ function Add-VSGlueSecurityConfigurationS3Encryptions { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration.S3Encryptions resource property to the template. + Adds an AWS::Glue::SecurityConfiguration.S3Encryptions resource property to the template. Specifies a list of S3Encryption, containing encyption configuration for Amazon Simple Storage Service (Amazon S3 data for a security configuration. .DESCRIPTION Adds an AWS::Glue::SecurityConfiguration.S3Encryptions resource property to the template. +Specifies a list of S3Encryption, containing encyption configuration for Amazon Simple Storage Service (Amazon S3 data for a security configuration. +*Required*: No + +*Type:* List of S3Encryption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html + +*Update requires:* No interruption .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryptions.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTableColumn.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTableColumn.ps1 index 1ba999988..fbe3a6d68 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTableColumn.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTableColumn.ps1 @@ -1,26 +1,32 @@ function Add-VSGlueTableColumn { <# .SYNOPSIS - Adds an AWS::Glue::Table.Column resource property to the template. + Adds an AWS::Glue::Table.Column resource property to the template. A column in a Table. .DESCRIPTION Adds an AWS::Glue::Table.Column resource property to the template. - +A column in a Table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html .PARAMETER Comment + A free-form text comment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-comment PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The data type of the Column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-type PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the Column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTableOrder.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTableOrder.ps1 index 6c05ffd1e..aa8a3c120 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTableOrder.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTableOrder.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueTableOrder { <# .SYNOPSIS - Adds an AWS::Glue::Table.Order resource property to the template. + Adds an AWS::Glue::Table.Order resource property to the template. Specifies the sort order of a sorted column. .DESCRIPTION Adds an AWS::Glue::Table.Order resource property to the template. - +Specifies the sort order of a sorted column. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html .PARAMETER Column + The name of the column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-column PrimitiveType: String UpdateType: Mutable .PARAMETER SortOrder + Indicates that the column is sorted in ascending order == 1, or in descending order ==0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-sortorder PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTableSerdeInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTableSerdeInfo.ps1 index 38973b287..566b40422 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTableSerdeInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTableSerdeInfo.ps1 @@ -1,26 +1,32 @@ function Add-VSGlueTableSerdeInfo { <# .SYNOPSIS - Adds an AWS::Glue::Table.SerdeInfo resource property to the template. + Adds an AWS::Glue::Table.SerdeInfo resource property to the template. Information about a serialization/deserialization program (SerDe that serves as an extractor and loader. .DESCRIPTION Adds an AWS::Glue::Table.SerdeInfo resource property to the template. - +Information about a serialization/deserialization program (SerDe that serves as an extractor and loader. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html .PARAMETER Parameters + These key-value pairs define initialization parameters for the SerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER SerializationLibrary + Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-serializationlibrary PrimitiveType: String UpdateType: Mutable .PARAMETER Name + Name of the SerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTableSkewedInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTableSkewedInfo.ps1 index a3ae74599..8545b6335 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTableSkewedInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTableSkewedInfo.ps1 @@ -1,28 +1,34 @@ function Add-VSGlueTableSkewedInfo { <# .SYNOPSIS - Adds an AWS::Glue::Table.SkewedInfo resource property to the template. + Adds an AWS::Glue::Table.SkewedInfo resource property to the template. Specifies skewed values in a table. Skewed values are those that occur with very high frequency. .DESCRIPTION Adds an AWS::Glue::Table.SkewedInfo resource property to the template. - +Specifies skewed values in a table. Skewed values are those that occur with very high frequency. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html .PARAMETER SkewedColumnNames + A list of names of columns that contain skewed values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnnames UpdateType: Mutable .PARAMETER SkewedColumnValues + A list of values that appear so frequently as to be considered skewed. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvalues UpdateType: Mutable .PARAMETER SkewedColumnValueLocationMaps + A mapping of skewed values to the columns that contain them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvaluelocationmaps PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTableStorageDescriptor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTableStorageDescriptor.ps1 index 98faf1d43..940acb481 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTableStorageDescriptor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTableStorageDescriptor.ps1 @@ -1,74 +1,98 @@ function Add-VSGlueTableStorageDescriptor { <# .SYNOPSIS - Adds an AWS::Glue::Table.StorageDescriptor resource property to the template. + Adds an AWS::Glue::Table.StorageDescriptor resource property to the template. Describes the physical storage of table data. .DESCRIPTION Adds an AWS::Glue::Table.StorageDescriptor resource property to the template. - +Describes the physical storage of table data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html .PARAMETER StoredAsSubDirectories + True if the table data is stored in subdirectories, or False if not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-storedassubdirectories PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Parameters + The user-supplied properties in key-value form. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER BucketColumns + A list of reducer grouping columns, clustering columns, and bucketing columns in the table. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-bucketcolumns UpdateType: Mutable .PARAMETER SkewedInfo + The information about values that appear frequently in a column skewed values. + Type: SkewedInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-skewedinfo UpdateType: Mutable .PARAMETER InputFormat + The input format: SequenceFileInputFormat binary, or TextInputFormat, or a custom format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-inputformat PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfBuckets + Must be specified if the table contains any dimension columns. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-numberofbuckets PrimitiveType: Integer UpdateType: Mutable .PARAMETER OutputFormat + The output format: SequenceFileOutputFormat binary, or IgnoreKeyTextOutputFormat, or a custom format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-outputformat PrimitiveType: String UpdateType: Mutable .PARAMETER Columns + A list of the Columns in the table. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-columns ItemType: Column UpdateType: Mutable .PARAMETER SerdeInfo + The serialization/deserialization SerDe information. + Type: SerdeInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-serdeinfo UpdateType: Mutable .PARAMETER SortColumns + A list specifying the sort order of each bucket in the table. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-sortcolumns ItemType: Order UpdateType: Mutable .PARAMETER Compressed + True if the data in the table is compressed, or False if not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-compressed PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Location + The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTableTableInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTableTableInput.ps1 index 65f66c6bb..4407928ac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTableTableInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTableTableInput.ps1 @@ -1,62 +1,84 @@ function Add-VSGlueTableTableInput { <# .SYNOPSIS - Adds an AWS::Glue::Table.TableInput resource property to the template. + Adds an AWS::Glue::Table.TableInput resource property to the template. A structure used to define a table. .DESCRIPTION Adds an AWS::Glue::Table.TableInput resource property to the template. - +A structure used to define a table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html .PARAMETER Owner + The table owner. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner PrimitiveType: String UpdateType: Mutable .PARAMETER ViewOriginalText + If the table is a view, the original text of the view; otherwise null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description PrimitiveType: String UpdateType: Mutable .PARAMETER TableType + The type of this table EXTERNAL_TABLE, VIRTUAL_VIEW, etc.. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + These key-value pairs define properties associated with the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER ViewExpandedText + If the table is a view, the expanded text of the view; otherwise null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext PrimitiveType: String UpdateType: Mutable .PARAMETER StorageDescriptor + A storage descriptor containing information about the physical storage of this table. + Type: StorageDescriptor Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor UpdateType: Mutable .PARAMETER PartitionKeys + A list of columns by which the table is partitioned. Only primitive types are supported as partition keys. +When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example: +"PartitionKeys": ] + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys ItemType: Column UpdateType: Mutable .PARAMETER Retention + The retention time for this table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + The table name. For Hive compatibility, this is folded to lowercase when it is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 index 8c7b8551a..3ed1e21c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 @@ -1,41 +1,56 @@ function Add-VSGlueTriggerAction { <# .SYNOPSIS - Adds an AWS::Glue::Trigger.Action resource property to the template. + Adds an AWS::Glue::Trigger.Action resource property to the template. Defines an action to be initiated by a trigger. .DESCRIPTION Adds an AWS::Glue::Trigger.Action resource property to the template. - +Defines an action to be initiated by a trigger. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html .PARAMETER NotificationProperty + + Action Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Action in the *AWS Glue Developer Guide* + Type: NotificationProperty Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-notificationproperty UpdateType: Mutable .PARAMETER CrawlerName + + Action Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Action in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-crawlername PrimitiveType: String UpdateType: Mutable .PARAMETER Timeout + + Action Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Action in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-timeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER JobName + The name of a job to be executed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-jobname PrimitiveType: String UpdateType: Mutable .PARAMETER Arguments + The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself. +You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes. +For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html in the *AWS Glue Developer Guide*. +For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html topic in the developer guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-arguments PrimitiveType: Json UpdateType: Mutable .PARAMETER SecurityConfiguration + The name of the SecurityConfiguration structure to be used with this action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-securityconfiguration PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 index 6e6c32af0..b78fc6ca8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 @@ -1,36 +1,46 @@ function Add-VSGlueTriggerCondition { <# .SYNOPSIS - Adds an AWS::Glue::Trigger.Condition resource property to the template. + Adds an AWS::Glue::Trigger.Condition resource property to the template. Defines a condition under which a trigger fires. .DESCRIPTION Adds an AWS::Glue::Trigger.Condition resource property to the template. - +Defines a condition under which a trigger fires. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html .PARAMETER CrawlerName + + Condition Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Condition in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlername PrimitiveType: String UpdateType: Mutable .PARAMETER State + The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-state PrimitiveType: String UpdateType: Mutable .PARAMETER CrawlState + + Condition Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Condition in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlstate PrimitiveType: String UpdateType: Mutable .PARAMETER LogicalOperator + A logical operator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-logicaloperator PrimitiveType: String UpdateType: Mutable .PARAMETER JobName + The name of the job whose JobRuns this condition applies to, and on which this trigger waits. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-jobname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerPredicate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerPredicate.ps1 index ae77ba6fe..07ad50423 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerPredicate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerPredicate.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueTriggerPredicate { <# .SYNOPSIS - Adds an AWS::Glue::Trigger.Predicate resource property to the template. + Adds an AWS::Glue::Trigger.Predicate resource property to the template. Defines the predicate of the trigger, which determines when it fires. .DESCRIPTION Adds an AWS::Glue::Trigger.Predicate resource property to the template. - +Defines the predicate of the trigger, which determines when it fires. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html .PARAMETER Logical + An optional field if only one condition is listed. If multiple conditions are listed, then this field is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-logical PrimitiveType: String UpdateType: Mutable .PARAMETER Conditions + A list of the conditions that determine when the trigger will fire. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-conditions ItemType: Condition diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnector.ps1 index 20459f4d5..97af13016 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnector.ps1 @@ -1,26 +1,36 @@ function Add-VSGreengrassConnectorDefinitionConnector { <# .SYNOPSIS - Adds an AWS::Greengrass::ConnectorDefinition.Connector resource property to the template. + Adds an AWS::Greengrass::ConnectorDefinition.Connector resource property to the template. Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS, and other cloud services. For more information, see Integrate with Services and Protocols Using Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ConnectorDefinition.Connector resource property to the template. +Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS, and other cloud services. For more information, see Integrate with Services and Protocols Using Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Connectors property of the ConnectorDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html property type contains a list of Connector property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html .PARAMETER ConnectorArn + The Amazon Resource Name ARN of the connector. +For more information about AWS-provided connectors, see AWS-Provided Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-connectorarn PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + The parameters or configuration used by the connector. +For more information about AWS-provided connectors, see AWS-Provided Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-parameters PrimitiveType: Json UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-id PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnectorDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnectorDefinitionVersion.ps1 index cabf7e340..2cbde0025 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnectorDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionConnectorDefinitionVersion.ps1 @@ -1,16 +1,24 @@ function Add-VSGreengrassConnectorDefinitionConnectorDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion resource property to the template. A connector definition version contains a list of connectors. .DESCRIPTION Adds an AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion resource property to the template. +A connector definition version contains a list of connectors. +**Note** + +After you create a connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, ConnectorDefinitionVersion is the property type of the InitialVersion property in the AWS::Greengrass::ConnectorDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html .PARAMETER Connectors + The connectors in this version. Only one instance of a given connector can be added to a connector definition version at a time. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html#cfn-greengrass-connectordefinition-connectordefinitionversion-connectors ItemType: Connector diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionVersionConnector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionVersionConnector.ps1 index d3d7dedab..6ae994de8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionVersionConnector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassConnectorDefinitionVersionConnector.ps1 @@ -1,26 +1,36 @@ function Add-VSGreengrassConnectorDefinitionVersionConnector { <# .SYNOPSIS - Adds an AWS::Greengrass::ConnectorDefinitionVersion.Connector resource property to the template. + Adds an AWS::Greengrass::ConnectorDefinitionVersion.Connector resource property to the template. Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS, and other cloud services. For more information, see Integrate with Services and Protocols Using Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ConnectorDefinitionVersion.Connector resource property to the template. +Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS, and other cloud services. For more information, see Integrate with Services and Protocols Using Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Connectors property of the AWS::Greengrass::ConnectorDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html resource contains a list of Connector property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html .PARAMETER ConnectorArn + The Amazon Resource Name ARN of the connector. +For more information about AWS-provided connectors, see AWS-Provided Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-connectorarn PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + The parameters or configuration that the connector uses. +For more information about AWS-provided connectors, see AWS-Provided Greengrass Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-parameters PrimitiveType: Json UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-id PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCore.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCore.ps1 index c42e0914d..dfb60c627 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCore.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCore.ps1 @@ -1,31 +1,41 @@ function Add-VSGreengrassCoreDefinitionCore { <# .SYNOPSIS - Adds an AWS::Greengrass::CoreDefinition.Core resource property to the template. + Adds an AWS::Greengrass::CoreDefinition.Core resource property to the template. A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::CoreDefinition.Core resource property to the template. + A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Cores property of the CoreDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html property type contains a list of Core property types. Currently, the list can contain only one core. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html .PARAMETER SyncShadow + Indicates whether the core's local shadow is synced with the cloud automatically. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-syncshadow PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ThingArn + The ARN of the core, which is an AWS IoT device thing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-thingarn PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-id PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateArn + The Amazon Resource Name ARN of the device certificate for the core. This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-certificatearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCoreDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCoreDefinitionVersion.ps1 index f4358d597..5ba1d15cf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCoreDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionCoreDefinitionVersion.ps1 @@ -1,16 +1,24 @@ function Add-VSGreengrassCoreDefinitionCoreDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::CoreDefinition.CoreDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::CoreDefinition.CoreDefinitionVersion resource property to the template. A core definition version contains a Greengrass core: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html. .DESCRIPTION Adds an AWS::Greengrass::CoreDefinition.CoreDefinitionVersion resource property to the template. + A core definition version contains a Greengrass core: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html. +**Note** + +After you create a core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, CoreDefinitionVersion is the property type of the InitialVersion property in the AWS::Greengrass::CoreDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html .PARAMETER Cores + The Greengrass core in this version. Currently, the Cores property for a core definition version can contain only one core. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html#cfn-greengrass-coredefinition-coredefinitionversion-cores ItemType: Core diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionVersionCore.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionVersionCore.ps1 index 18667885f..b941cc24c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionVersionCore.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassCoreDefinitionVersionCore.ps1 @@ -1,31 +1,41 @@ function Add-VSGreengrassCoreDefinitionVersionCore { <# .SYNOPSIS - Adds an AWS::Greengrass::CoreDefinitionVersion.Core resource property to the template. + Adds an AWS::Greengrass::CoreDefinitionVersion.Core resource property to the template. A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::CoreDefinitionVersion.Core resource property to the template. + A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Cores property of the AWS::Greengrass::CoreDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html resource contains a list of Core property types. Currently, the list can contain only one core. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html .PARAMETER SyncShadow + Indicates whether the core's local shadow is synced with the cloud automatically. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-syncshadow PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ThingArn + The Amazon Resource Name ARN of the core, which is an AWS IoT device thing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-thingarn PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-id PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateArn + The ARN of the device certificate for the core. This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-certificatearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDevice.ps1 index acc43c7f5..d1f234e04 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDevice.ps1 @@ -1,31 +1,41 @@ function Add-VSGreengrassDeviceDefinitionDevice { <# .SYNOPSIS - Adds an AWS::Greengrass::DeviceDefinition.Device resource property to the template. + Adds an AWS::Greengrass::DeviceDefinition.Device resource property to the template. A device is an AWS IoT device (thing that's added to a Greengrass group. Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::DeviceDefinition.Device resource property to the template. + A device is an AWS IoT device (thing that's added to a Greengrass group. Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Devices property of the DeviceDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html property type contains a list of Device property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html .PARAMETER SyncShadow + Indicates whether the device's local shadow is synced with the cloud automatically. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-syncshadow PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ThingArn + The ARN of the device, which is an AWS IoT device thing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-thingarn PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-id PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateArn + The Amazon Resource Name ARN of the device certificate for the device. This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-certificatearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDeviceDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDeviceDefinitionVersion.ps1 index ff4a935bc..f35fdeff7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDeviceDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionDeviceDefinitionVersion.ps1 @@ -1,16 +1,24 @@ function Add-VSGreengrassDeviceDefinitionDeviceDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion resource property to the template. A device definition version contains a list of devices: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html. .DESCRIPTION Adds an AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion resource property to the template. + A device definition version contains a list of devices: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html. +**Note** + +After you create a device definition version that contains the devices you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, DeviceDefinitionVersion is the property type of the InitialVersion property in the AWS::Greengrass::DeviceDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html .PARAMETER Devices + The devices in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html#cfn-greengrass-devicedefinition-devicedefinitionversion-devices ItemType: Device diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionVersionDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionVersionDevice.ps1 index 7f50dd5c9..4eef3dd5a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionVersionDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassDeviceDefinitionVersionDevice.ps1 @@ -1,31 +1,41 @@ function Add-VSGreengrassDeviceDefinitionVersionDevice { <# .SYNOPSIS - Adds an AWS::Greengrass::DeviceDefinitionVersion.Device resource property to the template. + Adds an AWS::Greengrass::DeviceDefinitionVersion.Device resource property to the template. A device is an AWS IoT device (thing that's added to a Greengrass group. Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::DeviceDefinitionVersion.Device resource property to the template. + A device is an AWS IoT device (thing that's added to a Greengrass group. Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass?: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Devices property of the AWS::Greengrass::DeviceDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html resource contains a list of Device property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html .PARAMETER SyncShadow + Indicates whether the device's local shadow is synced with the cloud automatically. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-syncshadow PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ThingArn + The Amazon Resource Name ARN of the device, which is an AWS IoT device thing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-thingarn PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-id PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateArn + The ARN of the device certificate for the device. This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-certificatearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionDefaultConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionDefaultConfig.ps1 index 109908748..e0bdf25b3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionDefaultConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionDefaultConfig.ps1 @@ -1,16 +1,20 @@ function Add-VSGreengrassFunctionDefinitionDefaultConfig { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.DefaultConfig resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.DefaultConfig resource property to the template. The default configuration that applies to all Lambda functions in the function definition version. Individual Lambda functions can override these settings. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.DefaultConfig resource property to the template. +The default configuration that applies to all Lambda functions in the function definition version. Individual Lambda functions can override these settings. + In an AWS CloudFormation template, DefaultConfig is a property of the FunctionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html .PARAMETER Execution + Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core. + Type: Execution Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html#cfn-greengrass-functiondefinition-defaultconfig-execution UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionEnvironment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionEnvironment.ps1 index dbaf20b8d..e0b7e43a3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionEnvironment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionEnvironment.ps1 @@ -1,32 +1,44 @@ function Add-VSGreengrassFunctionDefinitionEnvironment { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.Environment resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.Environment resource property to the template. The environment configuration for a Lambda function on the AWS IoT Greengrass core. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.Environment resource property to the template. +The environment configuration for a Lambda function on the AWS IoT Greengrass core. + In an AWS CloudFormation template, Environment is a property of the FunctionConfiguration : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html .PARAMETER Variables + Environment variables for the Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-variables PrimitiveType: Json UpdateType: Immutable .PARAMETER Execution + Settings for the Lambda execution environment in AWS IoT Greengrass. + Type: Execution Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-execution UpdateType: Immutable .PARAMETER ResourceAccessPolicies + A list of the resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. +This property applies only for Lambda functions that run in a Greengrass container. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-resourceaccesspolicies ItemType: ResourceAccessPolicy UpdateType: Immutable .PARAMETER AccessSysfs + Indicates whether the function is allowed to access the /sys directory on the core device, which allows the read device information from /sys. +This property applies only to Lambda functions that run in a Greengrass container. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-accesssysfs PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionExecution.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionExecution.ps1 index ae2ff6de0..fcfbe6356 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionExecution.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionExecution.ps1 @@ -1,21 +1,33 @@ function Add-VSGreengrassFunctionDefinitionExecution { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.Execution resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.Execution resource property to the template. Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.Execution resource property to the template. +Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core. + In an AWS CloudFormation template, Execution is a property of the DefaultConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html property type for a function definition version and the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html property type for a function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html .PARAMETER IsolationMode + The containerization that the Lambda function runs in. Valid values are GreengrassContainer or NoContainer. Typically, this is GreengrassContainer. For more information, see Containerization: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization in the *AWS IoT Greengrass Developer Guide*. ++ When set on the DefaultConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version. ++ When set on the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization. +We recommend that you run in a Greengrass container unless your business case requires that you run without containerization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-isolationmode PrimitiveType: String UpdateType: Immutable .PARAMETER RunAs + The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see Run as: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html in the *AWS IoT Greengrass Developer Guide*. ++ When set on the DefaultConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version. ++ When set on the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions. +Running as the root user increases risks to your data and device. Do not run as root UID/GID=0 unless your business case requires it. For more information and requirements, see Running a Lambda Function as Root: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root. + Type: RunAs Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-runas UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunction.ps1 index 4042eb940..800c1abf8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunction.ps1 @@ -1,26 +1,34 @@ function Add-VSGreengrassFunctionDefinitionFunction { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.Function resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.Function resource property to the template. A function is a Lambda function that's referenced from an AWS IoT Greengrass group. The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.Function resource property to the template. +A function is a Lambda function that's referenced from an AWS IoT Greengrass group. The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Functions property of the FunctionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html property type contains a list of Function property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html .PARAMETER FunctionArn + The Amazon Resource Name ARN of the alias recommended or version of the referenced Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionarn PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionConfiguration + The group-specific settings of the Lambda function. These settings configure the function's behavior in the Greengrass group. + Type: FunctionConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionconfiguration UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-id PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionConfiguration.ps1 index 86d3bdd36..9224f34a5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionConfiguration.ps1 @@ -1,46 +1,63 @@ function Add-VSGreengrassFunctionDefinitionFunctionConfiguration { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.FunctionConfiguration resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.FunctionConfiguration resource property to the template. The group-specific configuration settings for a Lambda function. These settings configure the function's behavior in the Greengrass group. For more information, see Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.FunctionConfiguration resource property to the template. +The group-specific configuration settings for a Lambda function. These settings configure the function's behavior in the Greengrass group. For more information, see Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, FunctionConfiguration is a property of the Function : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html .PARAMETER MemorySize + The memory size in KB required by the function. +This property applies only to Lambda functions that run in a Greengrass container. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-memorysize PrimitiveType: Integer UpdateType: Immutable .PARAMETER Pinned + Indicates whether the function is pinned or *long-lived*. Pinned functions start when the core starts and process all requests in the same container. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-pinned PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExecArgs + The execution arguments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-execargs PrimitiveType: String UpdateType: Immutable .PARAMETER Timeout + The allowed execution time in seconds after which the function should terminate. For pinned functions, this timeout applies for each request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-timeout PrimitiveType: Integer UpdateType: Immutable .PARAMETER EncodingType + The expected encoding type of the input payload for the function. Valid values are json default and binary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-encodingtype PrimitiveType: String UpdateType: Immutable .PARAMETER Environment + The environment configuration of the function. + Type: Environment Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-environment UpdateType: Immutable .PARAMETER Executable + The name of the function executable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-executable PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionDefinitionVersion.ps1 index e17e24078..1a4f20abc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionFunctionDefinitionVersion.ps1 @@ -1,21 +1,31 @@ function Add-VSGreengrassFunctionDefinitionFunctionDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion resource property to the template. A function definition version contains a list of functions. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion resource property to the template. +A function definition version contains a list of functions. +**Note** + +After you create a function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, FunctionDefinitionVersion is the property type of the InitialVersion property in the AWS::Greengrass::FunctionDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html .PARAMETER DefaultConfig + The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings. + Type: DefaultConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-defaultconfig UpdateType: Immutable .PARAMETER Functions + The functions in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-functions ItemType: Function diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionResourceAccessPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionResourceAccessPolicy.ps1 index 2b819a475..72e7c7132 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionResourceAccessPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionResourceAccessPolicy.ps1 @@ -1,21 +1,31 @@ function Add-VSGreengrassFunctionDefinitionResourceAccessPolicy { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy resource property to the template. A list of the resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy resource property to the template. +A list of the resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. +**Note** + +This property applies only to Lambda functions that run in a Greengrass container. + + In an AWS CloudFormation template, ResourceAccessPolicy is a property of the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html .PARAMETER ResourceId + The ID of the resource. This ID is assigned to the resource when you create the resource definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-resourceid PrimitiveType: String UpdateType: Immutable .PARAMETER Permission + The read-only or read-write access that the Lambda function has to the resource. Valid values are ro or rw. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-permission PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionRunAs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionRunAs.ps1 index da204cf60..fd639993b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionRunAs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionRunAs.ps1 @@ -1,21 +1,31 @@ function Add-VSGreengrassFunctionDefinitionRunAs { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition.RunAs resource property to the template. + Adds an AWS::Greengrass::FunctionDefinition.RunAs resource property to the template. The access identity whose permissions are used to run the Lambda function. This setting overrides the default access identity that's specified for the group (by default, ggc_user and ggc_group. You can override the user, group, or both. For more information, see Run as: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinition.RunAs resource property to the template. +The access identity whose permissions are used to run the Lambda function. This setting overrides the default access identity that's specified for the group (by default, ggc_user and ggc_group. You can override the user, group, or both. For more information, see Run as: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html in the *AWS IoT Greengrass Developer Guide*. +**Important** + +Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0 unless your business case requires it. For more information and requirements, see Running a Lambda Function as Root: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root. + + In an AWS CloudFormation template, RunAs is a property of the Execution : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html .PARAMETER Uid + The user ID whose permissions are used to run the Lambda function. You can use the getent passwd command on your core device to look up the user ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-uid PrimitiveType: Integer UpdateType: Immutable .PARAMETER Gid + The group ID whose permissions are used to run the Lambda function. You can use the getent group command on your core device to look up the group ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-gid PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionDefaultConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionDefaultConfig.ps1 index c4ca4afb2..0131eaa6e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionDefaultConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionDefaultConfig.ps1 @@ -1,16 +1,20 @@ function Add-VSGreengrassFunctionDefinitionVersionDefaultConfig { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig resource property to the template. The default configuration that applies to all Lambda functions in the function definition version. Individual Lambda functions can override these settings. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig resource property to the template. +The default configuration that applies to all Lambda functions in the function definition version. Individual Lambda functions can override these settings. + In an AWS CloudFormation template, DefaultConfig is a property of the AWS::Greengrass::FunctionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html .PARAMETER Execution + Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core. + Type: Execution Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html#cfn-greengrass-functiondefinitionversion-defaultconfig-execution UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionEnvironment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionEnvironment.ps1 index 50298f4f2..b7b05b0a8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionEnvironment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionEnvironment.ps1 @@ -1,32 +1,44 @@ function Add-VSGreengrassFunctionDefinitionVersionEnvironment { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.Environment resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.Environment resource property to the template. The environment configuration for a Lambda function on the AWS IoT Greengrass core. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.Environment resource property to the template. +The environment configuration for a Lambda function on the AWS IoT Greengrass core. + In an AWS CloudFormation template, Environment is a property of the FunctionConfiguration : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html .PARAMETER Variables + Environment variables for the Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-variables PrimitiveType: Json UpdateType: Immutable .PARAMETER Execution + Settings for the Lambda execution environment in AWS IoT Greengrass. + Type: Execution Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-execution UpdateType: Immutable .PARAMETER ResourceAccessPolicies + A list of the resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. +This property applies only to Lambda functions that run in a Greengrass container. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-resourceaccesspolicies ItemType: ResourceAccessPolicy UpdateType: Immutable .PARAMETER AccessSysfs + Indicates whether the function is allowed to access the /sys directory on the core device, which allows the read device information from /sys. +This property applies only to Lambda functions that run in a Greengrass container. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-accesssysfs PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionExecution.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionExecution.ps1 index 4163f93d7..25575dace 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionExecution.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionExecution.ps1 @@ -1,21 +1,33 @@ function Add-VSGreengrassFunctionDefinitionVersionExecution { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.Execution resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.Execution resource property to the template. Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.Execution resource property to the template. +Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core. + In an AWS CloudFormation template, Execution is a property of the DefaultConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html property type for a function definition version and the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html property type for a function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html .PARAMETER IsolationMode + The containerization that the Lambda function runs in. Valid values are GreengrassContainer or NoContainer. Typically, this is GreengrassContainer. For more information, see Containerization: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization in the *AWS IoT Greengrass Developer Guide*. ++ When set on the DefaultConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version. ++ When set on the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization. +We recommend that you run in a Greengrass container unless your business case requires that you run without containerization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-isolationmode PrimitiveType: String UpdateType: Immutable .PARAMETER RunAs + The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see Run as: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html in the *AWS IoT Greengrass Developer Guide*. ++ When set on the DefaultConfig : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version. ++ When set on the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions. +Running as the root user increases risks to your data and device. Do not run as root UID/GID=0 unless your business case requires it. For more information and requirements, see Running a Lambda Function as Root: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root. + Type: RunAs Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-runas UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunction.ps1 index eabdc942a..c2df71240 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunction.ps1 @@ -1,26 +1,34 @@ function Add-VSGreengrassFunctionDefinitionVersionFunction { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.Function resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.Function resource property to the template. A function is a Lambda function that's referenced from an AWS IoT Greengrass group. The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.Function resource property to the template. +A function is a Lambda function that's referenced from an AWS IoT Greengrass group. The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Functions property of the AWS::Greengrass::FunctionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html resource contains a list of Function property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html .PARAMETER FunctionArn + The Amazon Resource Name ARN of the alias recommended or version of the referenced Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionarn PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionConfiguration + The group-specific settings of the Lambda function. These settings configure the function's behavior in the Greengrass group. + Type: FunctionConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionconfiguration UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-id PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunctionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunctionConfiguration.ps1 index 62c5b2765..cf5cc00fe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunctionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionFunctionConfiguration.ps1 @@ -1,46 +1,63 @@ function Add-VSGreengrassFunctionDefinitionVersionFunctionConfiguration { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration resource property to the template. The group-specific configuration settings for a Lambda function. These settings configure the function's behavior in the Greengrass group. For more information, see Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration resource property to the template. +The group-specific configuration settings for a Lambda function. These settings configure the function's behavior in the Greengrass group. For more information, see Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, FunctionConfiguration is a property of the Function: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html .PARAMETER MemorySize + The memory size in KB required by the function. +This property applies only to Lambda functions that run in a Greengrass container. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-memorysize PrimitiveType: Integer UpdateType: Immutable .PARAMETER Pinned + Indicates whether the function is pinned or *long-lived*. Pinned functions start when the core starts and process all requests in the same container. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-pinned PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExecArgs + The execution arguments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-execargs PrimitiveType: String UpdateType: Immutable .PARAMETER Timeout + The allowed execution time in seconds after which the function should terminate. For pinned functions, this timeout applies for each request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-timeout PrimitiveType: Integer UpdateType: Immutable .PARAMETER EncodingType + The expected encoding type of the input payload for the function. Valid values are json default and binary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-encodingtype PrimitiveType: String UpdateType: Immutable .PARAMETER Environment + The environment configuration of the function. + Type: Environment Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-environment UpdateType: Immutable .PARAMETER Executable + The name of the function executable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-executable PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionResourceAccessPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionResourceAccessPolicy.ps1 index cae6423d0..95040a326 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionResourceAccessPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionResourceAccessPolicy.ps1 @@ -1,21 +1,31 @@ function Add-VSGreengrassFunctionDefinitionVersionResourceAccessPolicy { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy resource property to the template. A list of the resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy resource property to the template. +A list of the resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. +**Note** + +This property applies only to Lambda functions that run in a Greengrass container. + + In an AWS CloudFormation template, ResourceAccessPolicy is a property of the Environment : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html .PARAMETER ResourceId + The ID of the resource. This ID is assigned to the resource when you create the resource definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-resourceid PrimitiveType: String UpdateType: Immutable .PARAMETER Permission + The read-only or read-write access that the Lambda function has to the resource. Valid values are ro or rw. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-permission PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionRunAs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionRunAs.ps1 index 2758624f1..d5f1516f1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionRunAs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassFunctionDefinitionVersionRunAs.ps1 @@ -1,21 +1,31 @@ function Add-VSGreengrassFunctionDefinitionVersionRunAs { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion.RunAs resource property to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion.RunAs resource property to the template. The user and group permissions used to run the Lambda function. This setting overrides the default access identity that's specified for the group (by default, ggc_user and ggc_group. You can override the user, group, or both. For more information, see Run as: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::FunctionDefinitionVersion.RunAs resource property to the template. +The user and group permissions used to run the Lambda function. This setting overrides the default access identity that's specified for the group (by default, ggc_user and ggc_group. You can override the user, group, or both. For more information, see Run as: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html in the *AWS IoT Greengrass Developer Guide*. +**Important** + +Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0 unless your business case requires it. For more information and requirements, see Running a Lambda Function as Root: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root. + + In an AWS CloudFormation template, RunAs is a property of the Execution : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html .PARAMETER Uid + The user ID whose permissions are used to run the Lambda function. You can use the getent passwd command on your core device to look up the user ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-uid PrimitiveType: Integer UpdateType: Immutable .PARAMETER Gid + The group ID whose permissions are used to run the Lambda function. You can use the getent group command on your core device to look up the group ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-gid PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassGroupGroupVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassGroupGroupVersion.ps1 index f9007e3c1..8b7300441 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassGroupGroupVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassGroupGroupVersion.ps1 @@ -1,46 +1,62 @@ function Add-VSGreengrassGroupGroupVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::Group.GroupVersion resource property to the template. + Adds an AWS::Greengrass::Group.GroupVersion resource property to the template. A group version in AWS IoT Greengrass, which references of a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. .DESCRIPTION Adds an AWS::Greengrass::Group.GroupVersion resource property to the template. +A group version in AWS IoT Greengrass, which references of a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. + In an AWS CloudFormation template, GroupVersion is the property type of the InitialVersion property in the AWS::Greengrass::Group : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html .PARAMETER LoggerDefinitionVersionArn + The ARN of the logger definition version that contains the loggers you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-loggerdefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER DeviceDefinitionVersionArn + The ARN of the device definition version that contains the devices you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-devicedefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionDefinitionVersionArn + The ARN of the function definition version that contains the functions you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-functiondefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER CoreDefinitionVersionArn + The ARN of the core definition version that contains the core you want to deploy with the group version. Currently, the core definition version can contain only one core. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-coredefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceDefinitionVersionArn + The ARN of the resource definition version that contains the resources you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-resourcedefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER ConnectorDefinitionVersionArn + The Amazon Resource Name ARN of the connector definition version that contains the connectors you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-connectordefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER SubscriptionDefinitionVersionArn + The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-subscriptiondefinitionversionarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLogger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLogger.ps1 index 454b78965..3d090f6c4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLogger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLogger.ps1 @@ -1,36 +1,48 @@ function Add-VSGreengrassLoggerDefinitionLogger { <# .SYNOPSIS - Adds an AWS::Greengrass::LoggerDefinition.Logger resource property to the template. + Adds an AWS::Greengrass::LoggerDefinition.Logger resource property to the template. A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device. All log entries include a timestamp, log level, and information about the event. For more information, see Monitoring with AWS IoT Greengrass Logs: https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::LoggerDefinition.Logger resource property to the template. +A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device. All log entries include a timestamp, log level, and information about the event. For more information, see Monitoring with AWS IoT Greengrass Logs: https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Loggers property of the LoggerDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html property type contains a list of Logger property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html .PARAMETER Space + The amount of file space in KB to use when writing logs to the local file system. This property does not apply for CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-space PrimitiveType: Integer UpdateType: Immutable .PARAMETER Type + The storage mechanism for log events. Valid values are FileSystem or AWSCloudWatch. When AWSCloudWatch is used, log events are sent to CloudWatch Logs. When FileSystem is used, log events are stored on the local file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-type PrimitiveType: String UpdateType: Immutable .PARAMETER Level + The log-level threshold. Log events below this threshold are filtered out and aren't stored. Valid values are DEBUG, INFO recommended, WARN, ERROR, or FATAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-level PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-id PrimitiveType: String UpdateType: Immutable .PARAMETER Component + The source of the log event. Valid values are GreengrassSystem or Lambda. When GreengrassSystem is used, events from Greengrass system components are logged. When Lambda is used, events from user-defined Lambda functions are logged. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-component PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLoggerDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLoggerDefinitionVersion.ps1 index 93325da7b..b03381377 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLoggerDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionLoggerDefinitionVersion.ps1 @@ -1,16 +1,24 @@ function Add-VSGreengrassLoggerDefinitionLoggerDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion resource property to the template. A logger definition version contains a list of loggers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html. .DESCRIPTION Adds an AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion resource property to the template. + A logger definition version contains a list of loggers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html. +**Note** + +After you create a logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, LoggerDefinitionVersion is the property type of the InitialVersion property in the AWS::Greengrass::LoggerDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html .PARAMETER Loggers + The loggers in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html#cfn-greengrass-loggerdefinition-loggerdefinitionversion-loggers ItemType: Logger diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionVersionLogger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionVersionLogger.ps1 index a78f3562c..19c60b390 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionVersionLogger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassLoggerDefinitionVersionLogger.ps1 @@ -1,36 +1,48 @@ function Add-VSGreengrassLoggerDefinitionVersionLogger { <# .SYNOPSIS - Adds an AWS::Greengrass::LoggerDefinitionVersion.Logger resource property to the template. + Adds an AWS::Greengrass::LoggerDefinitionVersion.Logger resource property to the template. A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device. All log entries include a timestamp, log level, and information about the event. For more information, see Monitoring with AWS IoT Greengrass Logs: https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::LoggerDefinitionVersion.Logger resource property to the template. +A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device. All log entries include a timestamp, log level, and information about the event. For more information, see Monitoring with AWS IoT Greengrass Logs: https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Loggers property of the AWS::Greengrass::LoggerDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html resource contains a list of Logger property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html .PARAMETER Space + The amount of file space in KB to use when writing logs to the local file system. This property does not apply for CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-space PrimitiveType: Integer UpdateType: Immutable .PARAMETER Type + The storage mechanism for log events. Valid values are FileSystem or AWSCloudWatch. When AWSCloudWatch is used, log events are sent to CloudWatch Logs. When FileSystem is used, log events are stored on the local file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-type PrimitiveType: String UpdateType: Immutable .PARAMETER Level + The log-level threshold. Log events below this threshold are filtered out and aren't stored. Valid values are DEBUG, INFO recommended, WARN, ERROR, or FATAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-level PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-id PrimitiveType: String UpdateType: Immutable .PARAMETER Component + The source of the log event. Valid values are GreengrassSystem or Lambda. When GreengrassSystem is used, events from Greengrass system components are logged. When Lambda is used, events from user-defined Lambda functions are logged. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-component PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionGroupOwnerSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionGroupOwnerSetting.ps1 index 4f7a4805a..14556f96c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionGroupOwnerSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionGroupOwnerSetting.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionGroupOwnerSetting { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.GroupOwnerSetting resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.GroupOwnerSetting resource property to the template. Settings that define additional Linux OS group permissions to give to the Lambda function process. You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function's RunAs permissions. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.GroupOwnerSetting resource property to the template. +Settings that define additional Linux OS group permissions to give to the Lambda function process. You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function's RunAs permissions. + In an AWS CloudFormation template, GroupOwnerSetting is a property of the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html and https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html .PARAMETER AutoAddGroupOwner + Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process. This gives the Lambda process the file access permissions of the Linux group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html#cfn-greengrass-resourcedefinition-groupownersetting-autoaddgroupowner PrimitiveType: Boolean UpdateType: Immutable .PARAMETER GroupOwner + The name of the Linux group whose privileges you want to add to the Lambda process. This value is ignored if AutoAddGroupOwner is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html#cfn-greengrass-resourcedefinition-groupownersetting-groupowner PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalDeviceResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalDeviceResourceData.ps1 index 954e9f1a0..080898a77 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalDeviceResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalDeviceResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionLocalDeviceResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData resource property to the template. Settings for a local device resource, which represents a file under /dev. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData resource property to the template. +Settings for a local device resource, which represents a file under /dev. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, LocalDeviceResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html .PARAMETER SourcePath + The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under /dev. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html#cfn-greengrass-resourcedefinition-localdeviceresourcedata-sourcepath PrimitiveType: String UpdateType: Immutable .PARAMETER GroupOwnerSetting + Settings that define additional Linux OS group permissions to give to the Lambda function process. + Type: GroupOwnerSetting Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html#cfn-greengrass-resourcedefinition-localdeviceresourcedata-groupownersetting UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalVolumeResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalVolumeResourceData.ps1 index 09c4e3429..aacd3d091 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalVolumeResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionLocalVolumeResourceData.ps1 @@ -1,26 +1,34 @@ function Add-VSGreengrassResourceDefinitionLocalVolumeResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData resource property to the template. Settings for a local volume resource, which represents a file or directory on the root file system. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData resource property to the template. +Settings for a local volume resource, which represents a file or directory on the root file system. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, LocalVolumeResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html .PARAMETER SourcePath + The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with /sys. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-sourcepath PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationPath + The absolute local path of the resource in the Lambda environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-destinationpath PrimitiveType: String UpdateType: Immutable .PARAMETER GroupOwnerSetting + Settings that define additional Linux OS group permissions to give to the Lambda function process. + Type: GroupOwnerSetting Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-groupownersetting UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDataContainer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDataContainer.ps1 index 241aba392..bc218b45e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDataContainer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDataContainer.ps1 @@ -1,36 +1,52 @@ function Add-VSGreengrassResourceDefinitionResourceDataContainer { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.ResourceDataContainer resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.ResourceDataContainer resource property to the template. A container for resource data, which defines the resource type. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, or SecretsManagerSecretResourceData. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.ResourceDataContainer resource property to the template. +A container for resource data, which defines the resource type. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, or SecretsManagerSecretResourceData. +**Note** + +Only one resource type can be defined for a ResourceDataContainer instance. + + In an AWS CloudFormation template, ResourceDataContainer is a property of the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html .PARAMETER SecretsManagerSecretResourceData + Settings for a secret resource. + Type: SecretsManagerSecretResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-secretsmanagersecretresourcedata UpdateType: Immutable .PARAMETER SageMakerMachineLearningModelResourceData + Settings for a machine learning resource saved as an Amazon SageMaker training job. + Type: SageMakerMachineLearningModelResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-sagemakermachinelearningmodelresourcedata UpdateType: Immutable .PARAMETER LocalVolumeResourceData + Settings for a local volume resource. + Type: LocalVolumeResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-localvolumeresourcedata UpdateType: Immutable .PARAMETER LocalDeviceResourceData + Settings for a local device resource. + Type: LocalDeviceResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-localdeviceresourcedata UpdateType: Immutable .PARAMETER S3MachineLearningModelResourceData + Settings for a machine learning resource stored in Amazon S3. + Type: S3MachineLearningModelResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-s3machinelearningmodelresourcedata UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDefinitionVersion.ps1 index d3b49bbe1..93ce8cb6f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDefinitionVersion.ps1 @@ -1,16 +1,24 @@ function Add-VSGreengrassResourceDefinitionResourceDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion resource property to the template. A resource definition version contains a list of resources. (In AWS CloudFormation, resources are named *resource instances*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion resource property to the template. +A resource definition version contains a list of resources. (In AWS CloudFormation, resources are named *resource instances*. +**Note** + +After you create a resource definition version that contains the resources you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, ResourceDefinitionVersion is the property type of the InitialVersion property in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html .PARAMETER Resources + The resources in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html#cfn-greengrass-resourcedefinition-resourcedefinitionversion-resources ItemType: ResourceInstance diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceInstance.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceInstance.ps1 index c7060ffb8..e724f4ece 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceInstance.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceInstance.ps1 @@ -1,26 +1,35 @@ function Add-VSGreengrassResourceDefinitionResourceInstance { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.ResourceInstance resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.ResourceInstance resource property to the template. A local resource, machine learning resource, or secret resource. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html, Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html, and Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.ResourceInstance resource property to the template. +A local resource, machine learning resource, or secret resource. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html, Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html, and Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Resources property of the AWS::Greengrass::ResourceDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html resource contains a list of ResourceInstance property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html .PARAMETER ResourceDataContainer + A container for resource data. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, or SecretsManagerSecretResourceData. +Only one resource type can be defined for a ResourceDataContainer instance. + Type: ResourceDataContainer Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-resourcedatacontainer UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the resource. This value must be unique within the resource definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-id PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Maximum length 128 characters with pattern a-zA-Z0-9:_-]+. This must be unique within a Greengrass group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 index 70051483b..0b210b0c1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData resource property to the template. Settings for an Amazon S3 machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData resource property to the template. +Settings for an Amazon S3 machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, S3MachineLearningModelResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html .PARAMETER DestinationPath + The absolute local path of the resource inside the Lambda environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-destinationpath PrimitiveType: String UpdateType: Immutable .PARAMETER S3Uri + The URI of the source model in an Amazon S3 bucket. The model package must be in tar.gz or .zip format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-s3uri PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 index c1f0a9e3d..dbf314922 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData resource property to the template. Settings for an Secrets Manager machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData resource property to the template. +Settings for an Secrets Manager machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, SageMakerMachineLearningModelResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html .PARAMETER DestinationPath + The absolute local path of the resource inside the Lambda environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-destinationpath PrimitiveType: String UpdateType: Immutable .PARAMETER SageMakerJobArn + The Amazon Resource Name ARN of the Secrets Manager training job that represents the source model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-sagemakerjobarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSecretsManagerSecretResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSecretsManagerSecretResourceData.ps1 index fd111108b..34d8b8cea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSecretsManagerSecretResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSecretsManagerSecretResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionSecretsManagerSecretResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData resource property to the template. Settings for a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData resource property to the template. +Settings for a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, SecretsManagerSecretResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html .PARAMETER ARN + The Amazon Resource Name ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version represented by the AWSCURRENT staging label is included by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinition-secretsmanagersecretresourcedata-arn PrimitiveType: String UpdateType: Immutable .PARAMETER AdditionalStagingLabelsToDownload + The staging labels whose values you want to make available on the core, in addition to AWSCURRENT. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinition-secretsmanagersecretresourcedata-additionalstaginglabelstodownload diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionGroupOwnerSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionGroupOwnerSetting.ps1 index 5971c0eb3..1e01901c4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionGroupOwnerSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionGroupOwnerSetting.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionVersionGroupOwnerSetting { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting resource property to the template. Settings that define additional Linux OS group permissions to give to the Lambda function process. You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function's RunAs permissions. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting resource property to the template. +Settings that define additional Linux OS group permissions to give to the Lambda function process. You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function's RunAs permissions. + In an AWS CloudFormation template, GroupOwnerSetting is a property of the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html and https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html .PARAMETER AutoAddGroupOwner + Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process. This gives the Lambda process the file access permissions of the Linux group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-autoaddgroupowner PrimitiveType: Boolean UpdateType: Immutable .PARAMETER GroupOwner + The name of the Linux group whose privileges you want to add to the Lambda process. This value is ignored if AutoAddGroupOwner is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-groupowner PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalDeviceResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalDeviceResourceData.ps1 index 6b63db822..881b4248f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalDeviceResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalDeviceResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionVersionLocalDeviceResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData resource property to the template. Settings for a local device resource, which represents a file under /dev. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData resource property to the template. +Settings for a local device resource, which represents a file under /dev. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, LocalDeviceResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html .PARAMETER SourcePath + The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under /dev. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-sourcepath PrimitiveType: String UpdateType: Immutable .PARAMETER GroupOwnerSetting + Settings that define additional Linux OS group permissions to give to the Lambda function process. + Type: GroupOwnerSetting Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-groupownersetting UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalVolumeResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalVolumeResourceData.ps1 index b43d93a76..1c75202a0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalVolumeResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionLocalVolumeResourceData.ps1 @@ -1,26 +1,34 @@ function Add-VSGreengrassResourceDefinitionVersionLocalVolumeResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData resource property to the template. Settings for a local volume resource, which represents a file or directory on the root file system. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData resource property to the template. +Settings for a local volume resource, which represents a file or directory on the root file system. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, LocalVolumeResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html .PARAMETER SourcePath + The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with /sys. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-sourcepath PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationPath + The absolute local path of the resource in the Lambda environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-destinationpath PrimitiveType: String UpdateType: Immutable .PARAMETER GroupOwnerSetting + Settings that define additional Linux OS group permissions to give to the Lambda function process. + Type: GroupOwnerSetting Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-groupownersetting UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDataContainer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDataContainer.ps1 index e4c983c83..d2a1812b4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDataContainer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDataContainer.ps1 @@ -1,36 +1,52 @@ function Add-VSGreengrassResourceDefinitionVersionResourceDataContainer { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer resource property to the template. A container for resource data, which defines the resource type. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, or SecretsManagerSecretResourceData. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer resource property to the template. +A container for resource data, which defines the resource type. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, or SecretsManagerSecretResourceData. +**Note** + +Only one resource type can be defined for a ResourceDataContainer instance. + + In an AWS CloudFormation template, ResourceDataContainer is a property of the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html .PARAMETER SecretsManagerSecretResourceData + Settings for a secret resource. + Type: SecretsManagerSecretResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-secretsmanagersecretresourcedata UpdateType: Immutable .PARAMETER SageMakerMachineLearningModelResourceData + Settings for a machine learning resource saved as an Amazon SageMaker training job. + Type: SageMakerMachineLearningModelResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-sagemakermachinelearningmodelresourcedata UpdateType: Immutable .PARAMETER LocalVolumeResourceData + Settings for a local volume resource. + Type: LocalVolumeResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localvolumeresourcedata UpdateType: Immutable .PARAMETER LocalDeviceResourceData + Settings for a local device resource. + Type: LocalDeviceResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localdeviceresourcedata UpdateType: Immutable .PARAMETER S3MachineLearningModelResourceData + Settings for a machine learning resource stored in Amazon S3. + Type: S3MachineLearningModelResourceData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-s3machinelearningmodelresourcedata UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceInstance.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceInstance.ps1 index 60ff4d60b..581c2d289 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceInstance.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceInstance.ps1 @@ -1,26 +1,35 @@ function Add-VSGreengrassResourceDefinitionVersionResourceInstance { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance resource property to the template. A local resource, machine learning resource, or secret resource. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html, Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html, and Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance resource property to the template. +A local resource, machine learning resource, or secret resource. For more information, see Access Local Resources with Lambda Functions: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html, Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html, and Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, the Resources property of the AWS::Greengrass::ResourceDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html resource contains a list of ResourceInstance property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html .PARAMETER ResourceDataContainer + A container for resource data. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, or SecretsManagerSecretResourceData. +Only one resource type can be defined for a ResourceDataContainer instance. + Type: ResourceDataContainer Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-resourcedatacontainer UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the resource. This value must be unique within the resource definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-id PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Maximum length 128 characters with pattern a-zA-Z0-9:_-]+. This must be unique within a Greengrass group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 index 8e40d4ddd..4b0f8783a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData resource property to the template. Settings for an Amazon S3 machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData resource property to the template. +Settings for an Amazon S3 machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, S3MachineLearningModelResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html .PARAMETER DestinationPath + The absolute local path of the resource inside the Lambda environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-destinationpath PrimitiveType: String UpdateType: Immutable .PARAMETER S3Uri + The URI of the source model in an Amazon S3 bucket. The model package must be in tar.gz or .zip format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-s3uri PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 index b90fd555a..2611ace27 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData resource property to the template. Settings for an Secrets Manager machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData resource property to the template. +Settings for an Secrets Manager machine learning resource. For more information, see Perform Machine Learning Inference: https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, SageMakerMachineLearningModelResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html .PARAMETER DestinationPath + The absolute local path of the resource inside the Lambda environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-destinationpath PrimitiveType: String UpdateType: Immutable .PARAMETER SageMakerJobArn + The Amazon Resource Name ARN of the Secrets Manager training job that represents the source model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-sagemakerjobarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSecretsManagerSecretResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSecretsManagerSecretResourceData.ps1 index be99f0c22..c7b710ca6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSecretsManagerSecretResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSecretsManagerSecretResourceData.ps1 @@ -1,21 +1,27 @@ function Add-VSGreengrassResourceDefinitionVersionSecretsManagerSecretResourceData { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData resource property to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData resource property to the template. Settings for a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. .DESCRIPTION Adds an AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData resource property to the template. +Settings for a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see Deploy Secrets to the AWS IoT Greengrass Core: https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html in the *AWS IoT Greengrass Developer Guide*. + In an AWS CloudFormation template, SecretsManagerSecretResourceData can be used in the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html .PARAMETER ARN + The Amazon Resource Name ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version represented by the AWSCURRENT staging label is included by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-arn PrimitiveType: String UpdateType: Immutable .PARAMETER AdditionalStagingLabelsToDownload + The staging labels whose values you want to make available on the core, in addition to AWSCURRENT. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-additionalstaginglabelstodownload diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 index 1a96415a8..7f39398f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 @@ -1,31 +1,41 @@ function Add-VSGreengrassSubscriptionDefinitionSubscription { <# .SYNOPSIS - Adds an AWS::Greengrass::SubscriptionDefinition.Subscription resource property to the template. + Adds an AWS::Greengrass::SubscriptionDefinition.Subscription resource property to the template. Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service. A subscription defines a message source, message target, and a topic (or subject that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction. .DESCRIPTION Adds an AWS::Greengrass::SubscriptionDefinition.Subscription resource property to the template. +Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service. A subscription defines a message source, message target, and a topic (or subject that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction. + In an AWS CloudFormation template, the Subscriptions property of the SubscriptionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html property type contains a list of Subscription property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html .PARAMETER Target + The destination of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-target PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-id PrimitiveType: String UpdateType: Immutable .PARAMETER Source + The originator of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-source PrimitiveType: String UpdateType: Immutable .PARAMETER Subject + The MQTT topic used to route the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-subject PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscriptionDefinitionVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscriptionDefinitionVersion.ps1 index b9965c963..d14eeaa7e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscriptionDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscriptionDefinitionVersion.ps1 @@ -1,16 +1,24 @@ function Add-VSGreengrassSubscriptionDefinitionSubscriptionDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion resource property to the template. + Adds an AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion resource property to the template. A subscription definition version contains a list of subscriptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html. .DESCRIPTION Adds an AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion resource property to the template. + A subscription definition version contains a list of subscriptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html. +**Note** + +After you create a subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. + + In an AWS CloudFormation template, SubscriptionDefinitionVersion is the property type of the InitialVersion property in the AWS::Greengrass::SubscriptionDefinition : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html .PARAMETER Subscriptions + The subscriptions in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinition-subscriptiondefinitionversion-subscriptions ItemType: Subscription diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 index faecef532..c663f5b22 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 @@ -1,31 +1,41 @@ function Add-VSGreengrassSubscriptionDefinitionVersionSubscription { <# .SYNOPSIS - Adds an AWS::Greengrass::SubscriptionDefinitionVersion.Subscription resource property to the template. + Adds an AWS::Greengrass::SubscriptionDefinitionVersion.Subscription resource property to the template. Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service. A subscription defines a message source, message target, and a topic (or subject that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction. .DESCRIPTION Adds an AWS::Greengrass::SubscriptionDefinitionVersion.Subscription resource property to the template. +Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service. A subscription defines a message source, message target, and a topic (or subject that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction. + In an AWS CloudFormation template, the Subscriptions property of the AWS::Greengrass::SubscriptionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html resource contains a list of Subscription property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html .PARAMETER Target + The destination of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-target PrimitiveType: String UpdateType: Immutable .PARAMETER Id + A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern a-zA-Z0-9:_-]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-id PrimitiveType: String UpdateType: Immutable .PARAMETER Source + The originator of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-source PrimitiveType: String UpdateType: Immutable .PARAMETER Subject + The MQTT topic used to route the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-subject PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterCondition.ps1 index ec03bb32d..55a5a800b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterCondition.ps1 @@ -1,38 +1,48 @@ function Add-VSGuardDutyFilterCondition { <# .SYNOPSIS - Adds an AWS::GuardDuty::Filter.Condition resource property to the template. + Adds an AWS::GuardDuty::Filter.Condition resource property to the template. Specifies the condition to apply to a single field when filtering through GuardDuty findings. .DESCRIPTION Adds an AWS::GuardDuty::Filter.Condition resource property to the template. - +Specifies the condition to apply to a single field when filtering through GuardDuty findings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html .PARAMETER Lt + Represents the less than condition to apply to a single field when querying for findings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lt PrimitiveType: Integer UpdateType: Mutable .PARAMETER Gte + Represents the greater than or equal condition to apply to a single field when querying for findings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-gte PrimitiveType: Integer UpdateType: Mutable .PARAMETER Neq + Represents the not equal condition to apply to a single field when querying for findings. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-neq UpdateType: Mutable .PARAMETER Eq + Represents the equal condition to apply to a single field when querying for findings. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-eq UpdateType: Mutable .PARAMETER Lte + Represents the less than or equal condition to apply to a single field when querying for findings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lte PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterFindingCriteria.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterFindingCriteria.ps1 index 4719d0b74..fb63140ed 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterFindingCriteria.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGuardDutyFilterFindingCriteria.ps1 @@ -1,21 +1,25 @@ function Add-VSGuardDutyFilterFindingCriteria { <# .SYNOPSIS - Adds an AWS::GuardDuty::Filter.FindingCriteria resource property to the template. + Adds an AWS::GuardDuty::Filter.FindingCriteria resource property to the template. Represents a map of finding properties that match specified conditions and values when querying findings. .DESCRIPTION Adds an AWS::GuardDuty::Filter.FindingCriteria resource property to the template. - +Represents a map of finding properties that match specified conditions and values when querying findings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html .PARAMETER Criterion + Represents a map of finding properties that match specified conditions and values when querying findings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html#cfn-guardduty-filter-findingcriteria-criterion PrimitiveType: Json UpdateType: Mutable .PARAMETER ItemType + Specifies the condition to be applied to a single field when filtering through findings. + Type: Condition Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html#cfn-guardduty-filter-findingcriteria-itemtype UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIAMGroupPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIAMGroupPolicy.ps1 index 05baf94d1..86ade7219 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIAMGroupPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIAMGroupPolicy.ps1 @@ -1,21 +1,29 @@ function Add-VSIAMGroupPolicy { <# .SYNOPSIS - Adds an AWS::IAM::Group.Policy resource property to the template. + Adds an AWS::IAM::Group.Policy resource property to the template. Contains information about an attached policy. .DESCRIPTION Adds an AWS::IAM::Group.Policy resource property to the template. +Contains information about an attached policy. +An attached policy is a managed policy that has been attached to a user, group, or role. + +For more information about managed policies, refer to Managed Policies and Inline Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html in the *Using IAM* guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html .PARAMETER PolicyDocument + The policy document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER PolicyName + The friendly name not ARN identifying the policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policyname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIAMRolePolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIAMRolePolicy.ps1 index c3178ee3e..fa169612f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIAMRolePolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIAMRolePolicy.ps1 @@ -1,21 +1,29 @@ function Add-VSIAMRolePolicy { <# .SYNOPSIS - Adds an AWS::IAM::Role.Policy resource property to the template. + Adds an AWS::IAM::Role.Policy resource property to the template. Contains information about an attached policy. .DESCRIPTION Adds an AWS::IAM::Role.Policy resource property to the template. +Contains information about an attached policy. +An attached policy is a managed policy that has been attached to a user, group, or role. + +For more information about managed policies, refer to Managed Policies and Inline Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html in the *Using IAM* guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html .PARAMETER PolicyDocument + The policy document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER PolicyName + The friendly name not ARN identifying the policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policyname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIAMUserLoginProfile.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIAMUserLoginProfile.ps1 index dfceef440..c065352b4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIAMUserLoginProfile.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIAMUserLoginProfile.ps1 @@ -1,21 +1,25 @@ function Add-VSIAMUserLoginProfile { <# .SYNOPSIS - Adds an AWS::IAM::User.LoginProfile resource property to the template. + Adds an AWS::IAM::User.LoginProfile resource property to the template. Contains the user name and password create date for a user. .DESCRIPTION Adds an AWS::IAM::User.LoginProfile resource property to the template. - +Contains the user name and password create date for a user. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html .PARAMETER Password + The user's password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-password PrimitiveType: String UpdateType: Mutable .PARAMETER PasswordResetRequired + Specifies whether the user is required to set a new password on next sign-in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-passwordresetrequired PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIAMUserPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIAMUserPolicy.ps1 index 3bf95a4e6..6fe049832 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIAMUserPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIAMUserPolicy.ps1 @@ -1,21 +1,29 @@ function Add-VSIAMUserPolicy { <# .SYNOPSIS - Adds an AWS::IAM::User.Policy resource property to the template. + Adds an AWS::IAM::User.Policy resource property to the template. Contains information about an attached policy. .DESCRIPTION Adds an AWS::IAM::User.Policy resource property to the template. +Contains information about an attached policy. +An attached policy is a managed policy that has been attached to a user, group, or role. + +For more information about managed policies, refer to Managed Policies and Inline Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html in the *Using IAM* guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html .PARAMETER PolicyDocument + The policy document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER PolicyName + The friendly name not ARN identifying the policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policyname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectDeviceTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectDeviceTemplate.ps1 index 1ac524ebe..05c46b337 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectDeviceTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectDeviceTemplate.ps1 @@ -1,21 +1,27 @@ function Add-VSIoT1ClickProjectDeviceTemplate { <# .SYNOPSIS - Adds an AWS::IoT1Click::Project.DeviceTemplate resource property to the template. + Adds an AWS::IoT1Click::Project.DeviceTemplate resource property to the template. In AWS CloudFormation, use the DeviceTemplate property type to define the template for an AWS IoT 1-Click project. .DESCRIPTION Adds an AWS::IoT1Click::Project.DeviceTemplate resource property to the template. +In AWS CloudFormation, use the DeviceTemplate property type to define the template for an AWS IoT 1-Click project. +DeviceTemplate is a property of the AWS::IoT1Click::Project resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot1click-project-devicetemplate.html .PARAMETER DeviceType + The device type, which currently must be "button". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot1click-project-devicetemplate.html#cfn-iot1click-project-devicetemplate-devicetype PrimitiveType: String UpdateType: Mutable .PARAMETER CallbackOverrides + An optional AWS Lambda function to invoke instead of the default AWS Lambda function provided by the placement template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot1click-project-devicetemplate.html#cfn-iot1click-project-devicetemplate-callbackoverrides PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectPlacementTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectPlacementTemplate.ps1 index a534412f1..dac68ad14 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectPlacementTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoT1ClickProjectPlacementTemplate.ps1 @@ -1,21 +1,27 @@ function Add-VSIoT1ClickProjectPlacementTemplate { <# .SYNOPSIS - Adds an AWS::IoT1Click::Project.PlacementTemplate resource property to the template. + Adds an AWS::IoT1Click::Project.PlacementTemplate resource property to the template. In AWS CloudFormation, use the PlacementTemplate property type to define the template for an AWS IoT 1-Click project. .DESCRIPTION Adds an AWS::IoT1Click::Project.PlacementTemplate resource property to the template. +In AWS CloudFormation, use the PlacementTemplate property type to define the template for an AWS IoT 1-Click project. +PlacementTemplate is a property of the AWS::IoT1Click::Project resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot1click-project-placementtemplate.html .PARAMETER DeviceTemplates + An object specifying the DeviceTemplate: https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_DeviceTemplate.html for all placements using this PlacementTemplate: https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_PlacementTemplate.html template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot1click-project-placementtemplate.html#cfn-iot1click-project-placementtemplate-devicetemplates PrimitiveType: Json UpdateType: Immutable .PARAMETER DefaultAttributes + The default attributes key-value pairs to be applied to all placements using this template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot1click-project-placementtemplate.html#cfn-iot1click-project-placementtemplate-defaultattributes PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelChannelStorage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelChannelStorage.ps1 index 10e3c1ec3..630feef44 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelChannelStorage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelChannelStorage.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsChannelChannelStorage { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Channel.ChannelStorage resource property to the template. + Adds an AWS::IoTAnalytics::Channel.ChannelStorage resource property to the template. Where channel data is stored. .DESCRIPTION Adds an AWS::IoTAnalytics::Channel.ChannelStorage resource property to the template. - +Where channel data is stored. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html .PARAMETER CustomerManagedS3 + Use this to store channel data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel. + Type: CustomerManagedS3 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html#cfn-iotanalytics-channel-channelstorage-customermanageds3 UpdateType: Mutable .PARAMETER ServiceManagedS3 + Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel. + Type: ServiceManagedS3 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html#cfn-iotanalytics-channel-channelstorage-servicemanageds3 UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelCustomerManagedS3.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelCustomerManagedS3.ps1 index 95fbdbb86..30dcacddd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelCustomerManagedS3.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelCustomerManagedS3.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTAnalyticsChannelCustomerManagedS3 { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Channel.CustomerManagedS3 resource property to the template. + Adds an AWS::IoTAnalytics::Channel.CustomerManagedS3 resource property to the template. Use this to store channel data in an S3 bucket that you manage. When customer managed storage is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel. .DESCRIPTION Adds an AWS::IoTAnalytics::Channel.CustomerManagedS3 resource property to the template. - +Use this to store channel data in an S3 bucket that you manage. When customer managed storage is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html .PARAMETER Bucket + The name of the Amazon S3 bucket in which channel data is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER KeyPrefix + Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket each object in a bucket has exactly one key. The prefix must end with a '/'. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-keyprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 index d1ba5e79e..a1fdcdcd9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsChannelRetentionPeriod { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Channel.RetentionPeriod resource property to the template. + Adds an AWS::IoTAnalytics::Channel.RetentionPeriod resource property to the template. How long, in days, message data is kept. .DESCRIPTION Adds an AWS::IoTAnalytics::Channel.RetentionPeriod resource property to the template. - +How long, in days, message data is kept. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html .PARAMETER NumberOfDays + The number of days that message data is kept. The "unlimited" parameter must be false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-numberofdays PrimitiveType: Integer UpdateType: Mutable .PARAMETER Unlimited + If true, message data is kept indefinitely. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-unlimited PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelServiceManagedS3.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelServiceManagedS3.ps1 index e7e071c48..00f924535 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelServiceManagedS3.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelServiceManagedS3.ps1 @@ -1,11 +1,11 @@ function Add-VSIoTAnalyticsChannelServiceManagedS3 { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Channel.ServiceManagedS3 resource property to the template. + Adds an AWS::IoTAnalytics::Channel.ServiceManagedS3 resource property to the template. Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel. .DESCRIPTION Adds an AWS::IoTAnalytics::Channel.ServiceManagedS3 resource property to the template. - +Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-servicemanageds3.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetAction.ps1 index e8c1162a0..ed5c447d8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetAction.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTAnalyticsDatasetAction { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.Action resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.Action resource property to the template. Information needed to run the "containerAction" to produce data set contents. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.Action resource property to the template. - +Information needed to run the "containerAction" to produce data set contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html .PARAMETER ActionName + The name of the data set action by which data set contents are automatically created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-actionname PrimitiveType: String UpdateType: Mutable .PARAMETER ContainerAction + Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries. + Type: ContainerAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-containeraction UpdateType: Mutable .PARAMETER QueryAction + An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents. + Type: QueryAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-queryaction UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetContainerAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetContainerAction.ps1 index 6ffd2ea04..de352aaee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetContainerAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetContainerAction.ps1 @@ -1,32 +1,40 @@ function Add-VSIoTAnalyticsDatasetContainerAction { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.ContainerAction resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.ContainerAction resource property to the template. Information needed to run the "containerAction" to produce data set contents. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.ContainerAction resource property to the template. - +Information needed to run the "containerAction" to produce data set contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html .PARAMETER Variables + The values of variables used within the context of the execution of the containerized application basically, parameters passed to the application. Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue". + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-variables ItemType: Variable UpdateType: Mutable .PARAMETER ExecutionRoleArn + The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-executionrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Image + The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-image PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceConfiguration + Configuration of the resource which executes the "containerAction". + Type: ResourceConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-resourceconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 index 01806e5ff..a8ea0ef8d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule resource property to the template. When data set contents are created they are delivered to destination specified here. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule resource property to the template. - +When data set contents are created they are delivered to destination specified here. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html .PARAMETER Destination + The destination to which data set contents are delivered. + Type: DatasetContentDeliveryRuleDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-destination UpdateType: Mutable .PARAMETER EntryName + The name of the data set content delivery rules entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-entryname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 index c43815b03..873ff535f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination resource property to the template. The destination to which data set contents are delivered. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination resource property to the template. - +The destination to which data set contents are delivered. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html .PARAMETER IotEventsDestinationConfiguration + Configuration information for delivery of data set contents to AWS IoT Events. + Type: IotEventsDestinationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-ioteventsdestinationconfiguration UpdateType: Mutable .PARAMETER S3DestinationConfiguration + Configuration information for delivery of data set contents to Amazon S3. + Type: S3DestinationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-s3destinationconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 index 82250181f..ff18ce853 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTAnalyticsDatasetDatasetContentVersionValue { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DatasetContentVersionValue resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.DatasetContentVersionValue resource property to the template. The data set whose latest contents are used as input to the notebook or application. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DatasetContentVersionValue resource property to the template. - +The data set whose latest contents are used as input to the notebook or application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html .PARAMETER DatasetName + The name of the data set whose latest contents are used as input to the notebook or application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue-datasetname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 index b75e2dde3..afa7cce11 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetDeltaTime { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DeltaTime resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.DeltaTime resource property to the template. Used to limit data to that which has arrived since the last execution of the action. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DeltaTime resource property to the template. - +Used to limit data to that which has arrived since the last execution of the action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html .PARAMETER TimeExpression + An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression PrimitiveType: String UpdateType: Mutable .PARAMETER OffsetSeconds + The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the "in flight" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetFilter.ps1 index f63750b8e..afddf05ff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetFilter.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTAnalyticsDatasetFilter { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.Filter resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.Filter resource property to the template. Information which is used to filter message data, to segregate it according to the time frame in which it arrives. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.Filter resource property to the template. - +Information which is used to filter message data, to segregate it according to the time frame in which it arrives. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html .PARAMETER DeltaTime + Used to limit data to that which has arrived since the last execution of the action. + Type: DeltaTime Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html#cfn-iotanalytics-dataset-filter-deltatime UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 index 74e95726f..5cd4533ec 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetGlueConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.GlueConfiguration resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.GlueConfiguration resource property to the template. Configuration information for coordination with the AWS Glue ETL (extract, transform and load service. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.GlueConfiguration resource property to the template. - +Configuration information for coordination with the AWS Glue ETL (extract, transform and load service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html .PARAMETER TableName + The name of the table in your AWS Glue Data Catalog which is used to perform the ETL extract, transform and load operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName + The name of the database in your AWS Glue Data Catalog in which the table is located. An AWS Glue Data Catalog database contains Glue Data tables. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-databasename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 index cd04ba8d0..d7e9f580f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration resource property to the template. Configuration information for delivery of data set contents to AWS IoT Events. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration resource property to the template. - +Configuration information for delivery of data set contents to AWS IoT Events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html .PARAMETER InputName + The name of the AWS IoT Events input to which data set contents are delivered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-inputname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 index 89b8de35d..f24fd9097 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTAnalyticsDatasetOutputFileUriValue { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.OutputFileUriValue resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.OutputFileUriValue resource property to the template. The value of the variable as a structure that specifies an output file URI. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.OutputFileUriValue resource property to the template. - +The value of the variable as a structure that specifies an output file URI. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html .PARAMETER FileName + The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html#cfn-iotanalytics-dataset-variable-outputfileurivalue-filename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetQueryAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetQueryAction.ps1 index 52087d8ce..3ac88047c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetQueryAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetQueryAction.ps1 @@ -1,22 +1,26 @@ function Add-VSIoTAnalyticsDatasetQueryAction { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.QueryAction resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.QueryAction resource property to the template. An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.QueryAction resource property to the template. - +An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html .PARAMETER Filters + Pre-filters applied to message data. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-filters ItemType: Filter UpdateType: Mutable .PARAMETER SqlQuery + An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-sqlquery PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 index baa674854..959c83c2b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetResourceConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.ResourceConfiguration resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.ResourceConfiguration resource property to the template. The configuration of the resource used to execute the "containerAction". .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.ResourceConfiguration resource property to the template. - +The configuration of the resource used to execute the "containerAction". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html .PARAMETER VolumeSizeInGB + The size in GB of the persistent storage available to the resource instance used to execute the "containerAction" min: 1, max: 50. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb PrimitiveType: Integer UpdateType: Mutable .PARAMETER ComputeType + The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 vCPU=4, memory=16GiB or ACU_2 vCPU=8, memory=32GiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 index cc5fc3889..6772c8d8a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetRetentionPeriod { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.RetentionPeriod resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.RetentionPeriod resource property to the template. How long, in days, message data is kept. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.RetentionPeriod resource property to the template. - +How long, in days, message data is kept. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html .PARAMETER NumberOfDays + The number of days that message data is kept. The "unlimited" parameter must be false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-numberofdays PrimitiveType: Integer UpdateType: Mutable .PARAMETER Unlimited + If true, message data is kept indefinitely. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-unlimited PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 index e3d0a844a..1c2b507a4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 @@ -1,31 +1,39 @@ function Add-VSIoTAnalyticsDatasetS3DestinationConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.S3DestinationConfiguration resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.S3DestinationConfiguration resource property to the template. Configuration information for delivery of data set contents to Amazon S3. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.S3DestinationConfiguration resource property to the template. - +Configuration information for delivery of data set contents to Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html .PARAMETER GlueConfiguration + Configuration information for coordination with the AWS Glue ETL extract, transform and load service. + Type: GlueConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration UpdateType: Mutable .PARAMETER Bucket + The name of the Amazon S3 bucket to which data set contents are delivered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket each object in a bucket has exactly one key. To produce a unique key, you can use "!{iotanalytics:scheduledTime}" to insert the time of the scheduled SQL query run, or "!{iotanalytics:versioned} to insert a unique hash identifying the data set, for example: "/DataSet/!{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetSchedule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetSchedule.ps1 index 2ce6922d8..28da68cab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetSchedule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetSchedule.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTAnalyticsDatasetSchedule { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.Schedule resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.Schedule resource property to the template. The schedule for when to trigger an update. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.Schedule resource property to the template. - +The schedule for when to trigger an update. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger-schedule.html .PARAMETER ScheduleExpression + The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html in the Amazon CloudWatch documentation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger-schedule.html#cfn-iotanalytics-dataset-trigger-schedule-scheduleexpression PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTrigger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTrigger.ps1 index 0c71a2d3b..168f4d510 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTrigger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTrigger.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetTrigger { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.Trigger resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.Trigger resource property to the template. The "DatasetTrigger" that specifies when the data set is automatically updated. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.Trigger resource property to the template. - +The "DatasetTrigger" that specifies when the data set is automatically updated. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html .PARAMETER Schedule + The "Schedule" when the trigger is initiated. + Type: Schedule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-schedule UpdateType: Mutable .PARAMETER TriggeringDataset + Information about the data set whose content generation triggers the new data set content generation. + Type: TriggeringDataset Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-triggeringdataset UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 index a22320517..12a0ba189 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTAnalyticsDatasetTriggeringDataset { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.TriggeringDataset resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.TriggeringDataset resource property to the template. Information about the data set whose content generation triggers the new data set content generation. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.TriggeringDataset resource property to the template. - +Information about the data set whose content generation triggers the new data set content generation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html .PARAMETER DatasetName + The name of the data set whose content generation triggers the new data set content generation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html#cfn-iotanalytics-dataset-triggeringdataset-datasetname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 index 1a5d175d6..481c50c16 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 @@ -1,36 +1,46 @@ function Add-VSIoTAnalyticsDatasetVariable { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.Variable resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.Variable resource property to the template. An instance of a variable to be passed to the "containerAction" execution. Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue". .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.Variable resource property to the template. - +An instance of a variable to be passed to the "containerAction" execution. Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html .PARAMETER DatasetContentVersionValue + The value of the variable as a structure that specifies a data set content version. + Type: DatasetContentVersionValue Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue UpdateType: Mutable .PARAMETER DoubleValue + The value of the variable as a double numeric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-doublevalue PrimitiveType: Double UpdateType: Mutable .PARAMETER OutputFileUriValue + The value of the variable as a structure that specifies an output file URI. + Type: OutputFileUriValue Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-outputfileurivalue UpdateType: Mutable .PARAMETER VariableName + The name of the variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-variablename PrimitiveType: String UpdateType: Mutable .PARAMETER StringValue + The value of the variable as a string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-stringvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 index 9aa9097a5..eb1dc8013 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatasetVersioningConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.VersioningConfiguration resource property to the template. + Adds an AWS::IoTAnalytics::Dataset.VersioningConfiguration resource property to the template. Information about the versioning of data set contents. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.VersioningConfiguration resource property to the template. - +Information about the versioning of data set contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html .PARAMETER MaxVersions + How many versions of data set contents will be kept. The "unlimited" parameter must be false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-maxversions PrimitiveType: Integer UpdateType: Mutable .PARAMETER Unlimited + If true, unlimited versions of data set contents will be kept. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-unlimited PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreCustomerManagedS3.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreCustomerManagedS3.ps1 index f6e714a9e..ba285280d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreCustomerManagedS3.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreCustomerManagedS3.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTAnalyticsDatastoreCustomerManagedS3 { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Datastore.CustomerManagedS3 resource property to the template. + Adds an AWS::IoTAnalytics::Datastore.CustomerManagedS3 resource property to the template. Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store. .DESCRIPTION Adds an AWS::IoTAnalytics::Datastore.CustomerManagedS3 resource property to the template. - +Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html .PARAMETER Bucket + The name of the Amazon S3 bucket in which data store data is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER KeyPrefix + Optional] The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket each object in a bucket has exactly one key. The prefix must end with a '/'. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-keyprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreDatastoreStorage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreDatastoreStorage.ps1 index 28f3f3f7a..e8105f398 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreDatastoreStorage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreDatastoreStorage.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatastoreDatastoreStorage { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Datastore.DatastoreStorage resource property to the template. + Adds an AWS::IoTAnalytics::Datastore.DatastoreStorage resource property to the template. Where data store data is stored. .DESCRIPTION Adds an AWS::IoTAnalytics::Datastore.DatastoreStorage resource property to the template. - +Where data store data is stored. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html .PARAMETER CustomerManagedS3 + Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store. + Type: CustomerManagedS3 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-customermanageds3 UpdateType: Mutable .PARAMETER ServiceManagedS3 + Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store. + Type: ServiceManagedS3 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-servicemanageds3 UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 index 10a62a655..6bc60e71f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsDatastoreRetentionPeriod { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Datastore.RetentionPeriod resource property to the template. + Adds an AWS::IoTAnalytics::Datastore.RetentionPeriod resource property to the template. How long, in days, message data is kept. .DESCRIPTION Adds an AWS::IoTAnalytics::Datastore.RetentionPeriod resource property to the template. - +How long, in days, message data is kept. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html .PARAMETER NumberOfDays + The number of days that message data is kept. The "unlimited" parameter must be false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-numberofdays PrimitiveType: Integer UpdateType: Mutable .PARAMETER Unlimited + If true, message data is kept indefinitely. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-unlimited PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreServiceManagedS3.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreServiceManagedS3.ps1 index aa4c8f25d..3dd69a2fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreServiceManagedS3.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreServiceManagedS3.ps1 @@ -1,11 +1,11 @@ function Add-VSIoTAnalyticsDatastoreServiceManagedS3 { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Datastore.ServiceManagedS3 resource property to the template. + Adds an AWS::IoTAnalytics::Datastore.ServiceManagedS3 resource property to the template. Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store. .DESCRIPTION Adds an AWS::IoTAnalytics::Datastore.ServiceManagedS3 resource property to the template. - +Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-servicemanageds3.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineActivity.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineActivity.ps1 index 9e184f985..a5455cb44 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineActivity.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineActivity.ps1 @@ -1,61 +1,81 @@ function Add-VSIoTAnalyticsPipelineActivity { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Activity resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.Activity resource property to the template. An activity that performs a transformation on a message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Activity resource property to the template. - +An activity that performs a transformation on a message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html .PARAMETER SelectAttributes + Creates a new message using only the specified attributes from the original message. + Type: SelectAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-selectattributes UpdateType: Mutable .PARAMETER Datastore + Specifies where to store the processed message data. + Type: Datastore Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-datastore UpdateType: Mutable .PARAMETER Filter + Filters a message based on its attributes. + Type: Filter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-filter UpdateType: Mutable .PARAMETER AddAttributes + Adds other attributes based on existing attributes in the message. + Type: AddAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-addattributes UpdateType: Mutable .PARAMETER Channel + Determines the source of the messages to be processed. + Type: Channel Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-channel UpdateType: Mutable .PARAMETER DeviceShadowEnrich + Adds information from the AWS IoT Device Shadows service to a message. + Type: DeviceShadowEnrich Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceshadowenrich UpdateType: Mutable .PARAMETER Math + Computes an arithmetic expression using the message's attributes and adds it to the message. + Type: Math Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-math UpdateType: Mutable .PARAMETER Lambda + Runs a Lambda function to modify the message. + Type: Lambda Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-lambda UpdateType: Mutable .PARAMETER DeviceRegistryEnrich + Adds data from the AWS IoT device registry to your message. + Type: DeviceRegistryEnrich Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceregistryenrich UpdateType: Mutable .PARAMETER RemoveAttributes + Removes attributes from a message. + Type: RemoveAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-removeattributes UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineAddAttributes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineAddAttributes.ps1 index 072cbd489..d38163f6b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineAddAttributes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineAddAttributes.ps1 @@ -1,26 +1,33 @@ function Add-VSIoTAnalyticsPipelineAddAttributes { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.AddAttributes resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.AddAttributes resource property to the template. An activity that adds other attributes based on existing attributes in the message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.AddAttributes resource property to the template. - +An activity that adds other attributes based on existing attributes in the message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-next PrimitiveType: String UpdateType: Mutable .PARAMETER Attributes + A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute. +The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-attributes PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the 'addAttributes' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineChannel.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineChannel.ps1 index f6bc1a086..1d1a38143 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineChannel.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineChannel.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTAnalyticsPipelineChannel { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Channel resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.Channel resource property to the template. Determines the source of the messages to be processed. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Channel resource property to the template. - +Determines the source of the messages to be processed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html .PARAMETER ChannelName + The name of the channel from which the messages are processed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-channelname PrimitiveType: String UpdateType: Mutable .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-next PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'channel' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 index d00e17bf4..fe056389f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTAnalyticsPipelineDatastore { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Datastore resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.Datastore resource property to the template. The 'datastore' activity that specifies where to store the processed data. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Datastore resource property to the template. - +The 'datastore' activity that specifies where to store the processed data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html .PARAMETER DatastoreName + The name of the data store where processed messages are stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-datastorename PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'datastore' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceRegistryEnrich.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceRegistryEnrich.ps1 index 784a71a69..b5c0e21f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceRegistryEnrich.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceRegistryEnrich.ps1 @@ -1,36 +1,46 @@ function Add-VSIoTAnalyticsPipelineDeviceRegistryEnrich { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich resource property to the template. An activity that adds data from the AWS IoT device registry to your message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich resource property to the template. - +An activity that adds data from the AWS IoT device registry to your message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html .PARAMETER Attribute + The name of the attribute that is added to the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-attribute PrimitiveType: String UpdateType: Mutable .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-next PrimitiveType: String UpdateType: Mutable .PARAMETER ThingName + The name of the IoT device whose registry information is added to the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-thingname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role that allows access to the device's registry information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'deviceRegistryEnrich' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceShadowEnrich.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceShadowEnrich.ps1 index 8b3bde617..c4a1cc560 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceShadowEnrich.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDeviceShadowEnrich.ps1 @@ -1,36 +1,46 @@ function Add-VSIoTAnalyticsPipelineDeviceShadowEnrich { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich resource property to the template. An activity that adds information from the AWS IoT Device Shadows service to a message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich resource property to the template. - +An activity that adds information from the AWS IoT Device Shadows service to a message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html .PARAMETER Attribute + The name of the attribute that is added to the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute PrimitiveType: String UpdateType: Mutable .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next PrimitiveType: String UpdateType: Mutable .PARAMETER ThingName + The name of the IoT device whose shadow information is added to the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role that allows access to the device's shadow. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'deviceShadowEnrich' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineFilter.ps1 index d914aad53..c2a3ec3e4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineFilter.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTAnalyticsPipelineFilter { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Filter resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.Filter resource property to the template. An activity that filters a message based on its attributes. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Filter resource property to the template. - +An activity that filters a message based on its attributes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html .PARAMETER Filter + An expression that looks like an SQL WHERE clause that must return a Boolean value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-filter PrimitiveType: String UpdateType: Mutable .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-next PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'filter' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineLambda.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineLambda.ps1 index 2d17035bf..1563eba05 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineLambda.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineLambda.ps1 @@ -1,31 +1,40 @@ function Add-VSIoTAnalyticsPipelineLambda { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Lambda resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.Lambda resource property to the template. An activity that runs a Lambda function to modify the message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Lambda resource property to the template. - +An activity that runs a Lambda function to modify the message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html .PARAMETER BatchSize + The number of messages passed to the Lambda function for processing. +The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-batchsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-next PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaName + The name of the Lambda function that is run on the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-lambdaname PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'lambda' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineMath.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineMath.ps1 index 828ceb158..8dcb44cb4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineMath.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineMath.ps1 @@ -1,31 +1,39 @@ function Add-VSIoTAnalyticsPipelineMath { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Math resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.Math resource property to the template. An activity that computes an arithmetic expression using the message's attributes. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Math resource property to the template. - +An activity that computes an arithmetic expression using the message's attributes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html .PARAMETER Attribute + The name of the attribute that contains the result of the math operation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-attribute PrimitiveType: String UpdateType: Mutable .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-next PrimitiveType: String UpdateType: Mutable .PARAMETER Math + An expression that uses one or more existing attributes and must return an integer value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-math PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the 'math' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineRemoveAttributes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineRemoveAttributes.ps1 index 02fb3c972..81398136a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineRemoveAttributes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineRemoveAttributes.ps1 @@ -1,27 +1,33 @@ function Add-VSIoTAnalyticsPipelineRemoveAttributes { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.RemoveAttributes resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.RemoveAttributes resource property to the template. An activity that removes attributes from a message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.RemoveAttributes resource property to the template. - +An activity that removes attributes from a message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-next PrimitiveType: String UpdateType: Mutable .PARAMETER Attributes + A list of 1-50 attributes to remove from the message. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-attributes UpdateType: Mutable .PARAMETER Name + The name of the 'removeAttributes' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineSelectAttributes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineSelectAttributes.ps1 index 39f3e6add..a6226a28d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineSelectAttributes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineSelectAttributes.ps1 @@ -1,27 +1,33 @@ function Add-VSIoTAnalyticsPipelineSelectAttributes { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.SelectAttributes resource property to the template. + Adds an AWS::IoTAnalytics::Pipeline.SelectAttributes resource property to the template. Creates a new message using only the specified attributes from the original message. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.SelectAttributes resource property to the template. - +Creates a new message using only the specified attributes from the original message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html .PARAMETER Next + The next activity in the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-next PrimitiveType: String UpdateType: Mutable .PARAMETER Attributes + A list of the attributes to select from the message. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-attributes UpdateType: Mutable .PARAMETER Name + The name of the 'selectAttributes' activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 index f0f8e16fb..4a820385b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 @@ -1,61 +1,81 @@ function Add-VSIoTEventsDetectorModelAction { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Action resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.Action resource property to the template. An action to be performed when the "condition" is TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Action resource property to the template. - +An action to be performed when the "condition" is TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html .PARAMETER IotEvents + Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action. + Type: IotEvents Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotevents UpdateType: Mutable .PARAMETER ResetTimer + Information needed to reset the timer. + Type: ResetTimer Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-resettimer UpdateType: Mutable .PARAMETER Sqs + Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue. + Type: Sqs Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sqs UpdateType: Mutable .PARAMETER Firehose + Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream. + Type: Firehose Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-firehose UpdateType: Mutable .PARAMETER Sns + Sends an Amazon SNS message. + Type: Sns Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sns UpdateType: Mutable .PARAMETER IotTopicPublish + Publishes an MQTT message with the given topic to the AWS IoT message broker. + Type: IotTopicPublish Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iottopicpublish UpdateType: Mutable .PARAMETER SetTimer + Information needed to set the timer. + Type: SetTimer Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-settimer UpdateType: Mutable .PARAMETER ClearTimer + Information needed to clear the timer. + Type: ClearTimer Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-cleartimer UpdateType: Mutable .PARAMETER Lambda + Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action. + Type: Lambda Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-lambda UpdateType: Mutable .PARAMETER SetVariable + Sets a variable to a specified value. + Type: SetVariable Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-setvariable UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelClearTimer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelClearTimer.ps1 index 1961560f8..b28e7f656 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelClearTimer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelClearTimer.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelClearTimer { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.ClearTimer resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.ClearTimer resource property to the template. Information needed to clear the timer. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.ClearTimer resource property to the template. - +Information needed to clear the timer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html .PARAMETER TimerName + The name of the timer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html#cfn-iotevents-detectormodel-cleartimer-timername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelDetectorModelDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelDetectorModelDefinition.ps1 index 38a3ef53b..5bb55ff89 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelDetectorModelDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelDetectorModelDefinition.ps1 @@ -1,22 +1,26 @@ function Add-VSIoTEventsDetectorModelDetectorModelDefinition { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.DetectorModelDefinition resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.DetectorModelDefinition resource property to the template. Information that defines how a detector operates. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.DetectorModelDefinition resource property to the template. - +Information that defines how a detector operates. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html .PARAMETER States + Information about the states of the detector. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-states ItemType: State UpdateType: Mutable .PARAMETER InitialStateName + The state that is entered at the creation of each detector instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-initialstatename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 index 866ee78a9..682d61d74 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 @@ -1,27 +1,33 @@ function Add-VSIoTEventsDetectorModelEvent { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Event resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.Event resource property to the template. Specifies the "actions" to be performed when the "condition" evaluates to TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Event resource property to the template. - +Specifies the "actions" to be performed when the "condition" evaluates to TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html .PARAMETER Condition + Optional] The Boolean expression that when TRUE causes the "actions" to be performed. If not present, the actions are performed =TRUE; if the expression result is not a Boolean value, the actions are NOT performed =FALSE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-condition PrimitiveType: String UpdateType: Mutable .PARAMETER Actions + The actions to be performed. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-actions ItemType: Action UpdateType: Mutable .PARAMETER EventName + The name of the event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-eventname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelFirehose.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelFirehose.ps1 index 6a7159555..605eceb53 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelFirehose.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelFirehose.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTEventsDetectorModelFirehose { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Firehose resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.Firehose resource property to the template. Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Firehose resource property to the template. - +Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html .PARAMETER DeliveryStreamName + The name of the Kinesis Data Firehose delivery stream where the data is written. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-deliverystreamname PrimitiveType: String UpdateType: Mutable .PARAMETER Separator + A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: 'n' newline, 't' tab, 'rn' Windows newline, ',' comma. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-separator PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotEvents.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotEvents.ps1 index 43fc65520..663aba066 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotEvents.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotEvents.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelIotEvents { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.IotEvents resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.IotEvents resource property to the template. Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.IotEvents resource property to the template. - +Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html .PARAMETER InputName + The name of the AWS IoT Events input where the data is sent. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-inputname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotTopicPublish.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotTopicPublish.ps1 index e08b966c0..702f0d553 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotTopicPublish.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelIotTopicPublish.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelIotTopicPublish { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.IotTopicPublish resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.IotTopicPublish resource property to the template. Sends information about the detector model instance and the event which triggered the action in an MQTT message with the given topic to the AWS IoT message broker. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.IotTopicPublish resource property to the template. - +Sends information about the detector model instance and the event which triggered the action in an MQTT message with the given topic to the AWS IoT message broker. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html .PARAMETER MqttTopic + The MQTT topic of the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-mqtttopic PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelLambda.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelLambda.ps1 index 4ba02338b..0db0cb78a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelLambda.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelLambda.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelLambda { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Lambda resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.Lambda resource property to the template. Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Lambda resource property to the template. - +Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html .PARAMETER FunctionArn + The ARN of the AWS Lambda function which is executed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-functionarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnEnter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnEnter.ps1 index f201e8d4c..41749d6af 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnEnter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnEnter.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelOnEnter { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.OnEnter resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.OnEnter resource property to the template. When entering this state, perform these "actions" if the "condition" is TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.OnEnter resource property to the template. - +When entering this state, perform these "actions" if the "condition" is TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html .PARAMETER Events + Specifies the actions that are performed when the state is entered and the "condition" is TRUE. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html#cfn-iotevents-detectormodel-onenter-events ItemType: Event diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnExit.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnExit.ps1 index 3e774a923..79601b317 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnExit.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnExit.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelOnExit { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.OnExit resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.OnExit resource property to the template. When exiting this state, perform these "actions" if the "condition" is TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.OnExit resource property to the template. - +When exiting this state, perform these "actions" if the "condition" is TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html .PARAMETER Events + Specifies the actions that are performed when the state is exited and the "condition" is TRUE. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html#cfn-iotevents-detectormodel-onexit-events ItemType: Event diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnInput.ps1 index c1fcc5b9c..d823f34c8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelOnInput.ps1 @@ -1,22 +1,26 @@ function Add-VSIoTEventsDetectorModelOnInput { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.OnInput resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.OnInput resource property to the template. When an input is received and the "condition" is TRUE, perform the specified "actions". .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.OnInput resource property to the template. - +When an input is received and the "condition" is TRUE, perform the specified "actions". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html .PARAMETER Events + Specifies the actions that are performed when an input is received and the "condition" is TRUE. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-events ItemType: Event UpdateType: Mutable .PARAMETER TransitionEvents + Specifies the actions performed, and the next state entered, when an input is received and a "condition" evaluates to TRUE. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-transitionevents ItemType: TransitionEvent diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelResetTimer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelResetTimer.ps1 index c932289b7..2ebad79cd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelResetTimer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelResetTimer.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelResetTimer { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.ResetTimer resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.ResetTimer resource property to the template. Information needed to reset the timer. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.ResetTimer resource property to the template. - +Information needed to reset the timer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html .PARAMETER TimerName + The name of the timer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html#cfn-iotevents-detectormodel-resettimer-timername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetTimer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetTimer.ps1 index 610e2d1aa..b12c88ec6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetTimer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetTimer.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTEventsDetectorModelSetTimer { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.SetTimer resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.SetTimer resource property to the template. Information needed to set the timer. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.SetTimer resource property to the template. - +Information needed to set the timer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html .PARAMETER Seconds + The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-seconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER TimerName + The name of the timer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-timername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetVariable.ps1 index 17424400f..32835b2ff 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSetVariable.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTEventsDetectorModelSetVariable { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.SetVariable resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.SetVariable resource property to the template. Sets a variable to a specified value. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.SetVariable resource property to the template. - +Sets a variable to a specified value. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html .PARAMETER VariableName + The name of the variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-variablename PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The new value of the variable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSns.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSns.ps1 index 773586ea4..fb6e44379 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSns.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSns.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsDetectorModelSns { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Sns resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.Sns resource property to the template. Sends an Amazon SNS message. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Sns resource property to the template. - +Sends an Amazon SNS message. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html .PARAMETER TargetArn + The ARN of the Amazon SNS target where the message is sent. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-targetarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSqs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSqs.ps1 index 6dc6f3f2e..746866924 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSqs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelSqs.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTEventsDetectorModelSqs { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Sqs resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.Sqs resource property to the template. Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Sqs resource property to the template. - +Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html .PARAMETER UseBase64 + Set this to TRUE if you want the data to be Base-64 encoded before it is written to the queue. Otherwise, set this to FALSE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-usebase64 PrimitiveType: Boolean UpdateType: Mutable .PARAMETER QueueUrl + The URL of the Amazon SQS queue where the data is written. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-queueurl PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 index 107565ffd..b62e71585 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 @@ -1,31 +1,39 @@ function Add-VSIoTEventsDetectorModelState { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.State resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.State resource property to the template. Information that defines a state of a detector. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.State resource property to the template. - +Information that defines a state of a detector. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html .PARAMETER OnInput + When an input is received and the "condition" is TRUE, perform the specified "actions". + Type: OnInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-oninput UpdateType: Mutable .PARAMETER OnExit + When exiting this state, perform these "actions" if the specified "condition" is TRUE. + Type: OnExit Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onexit UpdateType: Mutable .PARAMETER StateName + The name of the state. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-statename PrimitiveType: String UpdateType: Mutable .PARAMETER OnEnter + When entering this state, perform these "actions" if the "condition" is TRUE. + Type: OnEnter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onenter UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 index 29811cbb1..17800eb44 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 @@ -1,32 +1,40 @@ function Add-VSIoTEventsDetectorModelTransitionEvent { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.TransitionEvent resource property to the template. + Adds an AWS::IoTEvents::DetectorModel.TransitionEvent resource property to the template. Specifies the actions performed and the next state entered when a "condition" evaluates to TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.TransitionEvent resource property to the template. - +Specifies the actions performed and the next state entered when a "condition" evaluates to TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html .PARAMETER Condition + Required] A Boolean expression that when TRUE causes the actions to be performed and the "nextState" to be entered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-condition PrimitiveType: String UpdateType: Mutable .PARAMETER Actions + The actions to be performed. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-actions ItemType: Action UpdateType: Mutable .PARAMETER NextState + The next state to enter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-nextstate PrimitiveType: String UpdateType: Mutable .PARAMETER EventName + The name of the transition event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-eventname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 index 7b03500a7..91b0e684f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 @@ -1,16 +1,19 @@ function Add-VSIoTEventsInputAttribute { <# .SYNOPSIS - Adds an AWS::IoTEvents::Input.Attribute resource property to the template. + Adds an AWS::IoTEvents::Input.Attribute resource property to the template. The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values specified here are available for use in the condition expressions used by detectors. .DESCRIPTION Adds an AWS::IoTEvents::Input.Attribute resource property to the template. - +The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values specified here are available for use in the condition expressions used by detectors. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html .PARAMETER JsonPath + An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system BatchPutMessage. Each such message contains a JSON payload, and the attribute and its paired value specified here are available for use in the "condition" expressions used by detectors. +Syntax: .... + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html#cfn-iotevents-input-attribute-jsonpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 index ecb4f3218..4f51a78f1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTEventsInputInputDefinition { <# .SYNOPSIS - Adds an AWS::IoTEvents::Input.InputDefinition resource property to the template. + Adds an AWS::IoTEvents::Input.InputDefinition resource property to the template. The definition of the input. .DESCRIPTION Adds an AWS::IoTEvents::Input.InputDefinition resource property to the template. - +The definition of the input. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html .PARAMETER Attributes + The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes and their paired values specified here are available for use in the "condition" expressions used by detectors that monitor this input. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html#cfn-iotevents-input-inputdefinition-attributes ItemType: Attribute diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTThingAttributePayload.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTThingAttributePayload.ps1 index 17805fd71..e17da56e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTThingAttributePayload.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTThingAttributePayload.ps1 @@ -1,16 +1,19 @@ function Add-VSIoTThingAttributePayload { <# .SYNOPSIS - Adds an AWS::IoT::Thing.AttributePayload resource property to the template. + Adds an AWS::IoT::Thing.AttributePayload resource property to the template. The AttributePayload property specifies up to three attributes for an AWS IoT as key–value pairs. AttributePayload is a property of the AWS::IoT::Thing: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html resource. .DESCRIPTION Adds an AWS::IoT::Thing.AttributePayload resource property to the template. - +The AttributePayload property specifies up to three attributes for an AWS IoT as key–value pairs. AttributePayload is a property of the AWS::IoT::Thing: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html .PARAMETER Attributes + A JSON string containing up to three key-value pair in JSON format. For example: +{"attributes":{"string1":"string2"}} + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html#cfn-iot-thing-attributepayload-attributes DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTThingsGraphFlowTemplateDefinitionDocument.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTThingsGraphFlowTemplateDefinitionDocument.ps1 index 234e41979..6b714d64b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTThingsGraphFlowTemplateDefinitionDocument.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTThingsGraphFlowTemplateDefinitionDocument.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTThingsGraphFlowTemplateDefinitionDocument { <# .SYNOPSIS - Adds an AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument resource property to the template. + Adds an AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument resource property to the template. A document that defines an entity. .DESCRIPTION Adds an AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument resource property to the template. - +A document that defines an entity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotthingsgraph-flowtemplate-definitiondocument.html .PARAMETER Language + The language used to define the entity. GRAPHQL is the only valid value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotthingsgraph-flowtemplate-definitiondocument.html#cfn-iotthingsgraph-flowtemplate-definitiondocument-language PrimitiveType: String UpdateType: Mutable .PARAMETER Text + The GraphQL text that defines the entity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotthingsgraph-flowtemplate-definitiondocument.html#cfn-iotthingsgraph-flowtemplate-definitiondocument-text PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleAction.ps1 index b3353b3c4..32d59e745 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleAction.ps1 @@ -1,81 +1,109 @@ function Add-VSIoTTopicRuleAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.Action resource property to the template. + Adds an AWS::IoT::TopicRule.Action resource property to the template. Describes the actions associated with a rule. .DESCRIPTION Adds an AWS::IoT::TopicRule.Action resource property to the template. - +Describes the actions associated with a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html .PARAMETER CloudwatchAlarm + Change the state of a CloudWatch alarm. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchalarm Type: CloudwatchAlarmAction UpdateType: Mutable .PARAMETER CloudwatchMetric + Capture a CloudWatch metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchmetric Type: CloudwatchMetricAction UpdateType: Mutable .PARAMETER DynamoDB + Write to a DynamoDB table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodb Type: DynamoDBAction UpdateType: Mutable .PARAMETER DynamoDBv2 + Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodbv2 Type: DynamoDBv2Action UpdateType: Mutable .PARAMETER Elasticsearch + Write data to an Amazon Elasticsearch Service domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-elasticsearch Type: ElasticsearchAction UpdateType: Mutable .PARAMETER Firehose + Write to an Amazon Kinesis Firehose stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-firehose Type: FirehoseAction UpdateType: Mutable .PARAMETER IotAnalytics + Sends message data to an AWS IoT Analytics channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotanalytics Type: IotAnalyticsAction UpdateType: Mutable .PARAMETER Kinesis + Write data to an Amazon Kinesis stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kinesis Type: KinesisAction UpdateType: Mutable .PARAMETER Lambda + Invoke a Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-lambda Type: LambdaAction UpdateType: Mutable .PARAMETER Republish + Publish to another MQTT topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-republish Type: RepublishAction UpdateType: Mutable .PARAMETER S3 + Write to an Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-s3 Type: S3Action UpdateType: Mutable .PARAMETER Sns + Publish to an Amazon SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sns Type: SnsAction UpdateType: Mutable .PARAMETER Sqs + Publish to an Amazon SQS queue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sqs Type: SqsAction UpdateType: Mutable .PARAMETER StepFunctions + Starts execution of a Step Functions state machine. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-stepfunctions Type: StepFunctionsAction UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchAlarmAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchAlarmAction.ps1 index ab4f139ef..d46649571 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchAlarmAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchAlarmAction.ps1 @@ -1,31 +1,39 @@ function Add-VSIoTTopicRuleCloudwatchAlarmAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.CloudwatchAlarmAction resource property to the template. + Adds an AWS::IoT::TopicRule.CloudwatchAlarmAction resource property to the template. Describes an action that updates a CloudWatch alarm. .DESCRIPTION Adds an AWS::IoT::TopicRule.CloudwatchAlarmAction resource property to the template. - +Describes an action that updates a CloudWatch alarm. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html .PARAMETER AlarmName + The CloudWatch alarm name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-alarmname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The IAM role that allows access to the CloudWatch alarm. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER StateReason + The reason for the alarm change. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statereason PrimitiveType: String UpdateType: Mutable .PARAMETER StateValue + The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statevalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchMetricAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchMetricAction.ps1 index 0e3918dcb..0c8eb2d29 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchMetricAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleCloudwatchMetricAction.ps1 @@ -1,41 +1,53 @@ function Add-VSIoTTopicRuleCloudwatchMetricAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.CloudwatchMetricAction resource property to the template. + Adds an AWS::IoT::TopicRule.CloudwatchMetricAction resource property to the template. Describes an action that captures a CloudWatch metric. .DESCRIPTION Adds an AWS::IoT::TopicRule.CloudwatchMetricAction resource property to the template. - +Describes an action that captures a CloudWatch metric. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html .PARAMETER MetricName + The CloudWatch metric name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER MetricNamespace + The CloudWatch metric namespace name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricnamespace PrimitiveType: String UpdateType: Mutable .PARAMETER MetricTimestamp + An optional Unix timestamp: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metrictimestamp PrimitiveType: String UpdateType: Mutable .PARAMETER MetricUnit + The metric unit: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit supported by CloudWatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricunit PrimitiveType: String UpdateType: Mutable .PARAMETER MetricValue + The CloudWatch metric value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricvalue PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The IAM role that allows access to the CloudWatch metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBAction.ps1 index 347142656..cfa6ec291 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBAction.ps1 @@ -1,56 +1,88 @@ function Add-VSIoTTopicRuleDynamoDBAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.DynamoDBAction resource property to the template. + Adds an AWS::IoT::TopicRule.DynamoDBAction resource property to the template. Describes an action to write to a DynamoDB table. .DESCRIPTION Adds an AWS::IoT::TopicRule.DynamoDBAction resource property to the template. +Describes an action to write to a DynamoDB table. +The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table. + +The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${*sql-expression*}. + +You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic: + +"hashKeyValue": "${topic(3}" + +The following field uses the timestamp: + +"rangeKeyValue": "${timestamp(}" + +For more information, see DynamoDBv2 Action: https://docs.aws.amazon.com/iot/latest/developerguide/iot-rule-actions.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html .PARAMETER HashKeyField + The hash key name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyfield PrimitiveType: String UpdateType: Mutable .PARAMETER HashKeyType + The hash key type. Valid values are "STRING" or "NUMBER" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeytype PrimitiveType: String UpdateType: Mutable .PARAMETER HashKeyValue + The hash key value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyvalue PrimitiveType: String UpdateType: Mutable .PARAMETER PayloadField + The action payload. This name can be customized. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-payloadfield PrimitiveType: String UpdateType: Mutable .PARAMETER RangeKeyField + The range key name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyfield PrimitiveType: String UpdateType: Mutable .PARAMETER RangeKeyType + The range key type. Valid values are "STRING" or "NUMBER" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeytype PrimitiveType: String UpdateType: Mutable .PARAMETER RangeKeyValue + The range key value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyvalue PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM role that grants access to the DynamoDB table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER TableName + The name of the DynamoDB table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-tablename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBv2Action.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBv2Action.ps1 index 93004f0f2..565cee7fd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBv2Action.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleDynamoDBv2Action.ps1 @@ -1,21 +1,29 @@ function Add-VSIoTTopicRuleDynamoDBv2Action { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.DynamoDBv2Action resource property to the template. + Adds an AWS::IoT::TopicRule.DynamoDBv2Action resource property to the template. Describes an action to write to a DynamoDB table. .DESCRIPTION Adds an AWS::IoT::TopicRule.DynamoDBv2Action resource property to the template. +Describes an action to write to a DynamoDB table. +This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html .PARAMETER PutItem + Specifies the DynamoDB table to which the message data will be written. For example: +{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } } +Each attribute in the message payload will be written to a separate column in the DynamoDB database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-putitem Type: PutItemInput UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM role that grants access to the DynamoDB table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleElasticsearchAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleElasticsearchAction.ps1 index 77d0fb64c..dd816cab2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleElasticsearchAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleElasticsearchAction.ps1 @@ -1,36 +1,46 @@ function Add-VSIoTTopicRuleElasticsearchAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.ElasticsearchAction resource property to the template. + Adds an AWS::IoT::TopicRule.ElasticsearchAction resource property to the template. Describes an action that writes data to an Amazon Elasticsearch Service domain. .DESCRIPTION Adds an AWS::IoT::TopicRule.ElasticsearchAction resource property to the template. - +Describes an action that writes data to an Amazon Elasticsearch Service domain. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html .PARAMETER Endpoint + The endpoint of your Elasticsearch domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-endpoint PrimitiveType: String UpdateType: Mutable .PARAMETER Id + The unique identifier for the document you are storing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-id PrimitiveType: String UpdateType: Mutable .PARAMETER Index + The Elasticsearch index where you want to store your data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-index PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The IAM role ARN that has access to Elasticsearch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of document you are storing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleFirehoseAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleFirehoseAction.ps1 index 5dee96cd8..89aaabc7f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleFirehoseAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleFirehoseAction.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTTopicRuleFirehoseAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.FirehoseAction resource property to the template. + Adds an AWS::IoT::TopicRule.FirehoseAction resource property to the template. Describes an action that writes data to an Amazon Kinesis Firehose stream. .DESCRIPTION Adds an AWS::IoT::TopicRule.FirehoseAction resource property to the template. - +Describes an action that writes data to an Amazon Kinesis Firehose stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html .PARAMETER DeliveryStreamName + The delivery stream name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-deliverystreamname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The IAM role that grants access to the Amazon Kinesis Firehose stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Separator + A character separator that will be used to separate records written to the Firehose stream. Valid values are: 'n' newline, 't' tab, 'rn' Windows newline, ',' comma. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-separator PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleIotAnalyticsAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleIotAnalyticsAction.ps1 index f5efb3764..3da2aa9d2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleIotAnalyticsAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleIotAnalyticsAction.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTTopicRuleIotAnalyticsAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.IotAnalyticsAction resource property to the template. + Adds an AWS::IoT::TopicRule.IotAnalyticsAction resource property to the template. Sends message data to an AWS IoT Analytics channel. .DESCRIPTION Adds an AWS::IoT::TopicRule.IotAnalyticsAction resource property to the template. - +Sends message data to an AWS IoT Analytics channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html .PARAMETER ChannelName + The name of the IoT Analytics channel to which message data will be sent. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-channelname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics iotanalytics:BatchPutMessage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleKinesisAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleKinesisAction.ps1 index cebf6a130..3bb3df087 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleKinesisAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleKinesisAction.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTTopicRuleKinesisAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.KinesisAction resource property to the template. + Adds an AWS::IoT::TopicRule.KinesisAction resource property to the template. Describes an action to write data to an Amazon Kinesis stream. .DESCRIPTION Adds an AWS::IoT::TopicRule.KinesisAction resource property to the template. - +Describes an action to write data to an Amazon Kinesis stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html .PARAMETER PartitionKey + The partition key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-partitionkey PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM role that grants access to the Amazon Kinesis stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER StreamName + The name of the Amazon Kinesis stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-streamname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleLambdaAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleLambdaAction.ps1 index 901859e8b..5b782f7c1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleLambdaAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleLambdaAction.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTTopicRuleLambdaAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.LambdaAction resource property to the template. + Adds an AWS::IoT::TopicRule.LambdaAction resource property to the template. Describes an action to invoke a Lambda function. .DESCRIPTION Adds an AWS::IoT::TopicRule.LambdaAction resource property to the template. - +Describes an action to invoke a Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html .PARAMETER FunctionArn + The ARN of the Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html#cfn-iot-topicrule-lambdaaction-functionarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRulePutItemInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRulePutItemInput.ps1 index e93bef78a..8e7eab5e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRulePutItemInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRulePutItemInput.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTTopicRulePutItemInput { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.PutItemInput resource property to the template. + Adds an AWS::IoT::TopicRule.PutItemInput resource property to the template. The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written. .DESCRIPTION Adds an AWS::IoT::TopicRule.PutItemInput resource property to the template. - +The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html .PARAMETER TableName + The table where the message data will be written. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html#cfn-iot-topicrule-putiteminput-tablename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleRepublishAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleRepublishAction.ps1 index 70fd2a128..538b3d4ac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleRepublishAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleRepublishAction.ps1 @@ -1,21 +1,25 @@ function Add-VSIoTTopicRuleRepublishAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.RepublishAction resource property to the template. + Adds an AWS::IoT::TopicRule.RepublishAction resource property to the template. Describes an action to republish to another topic. .DESCRIPTION Adds an AWS::IoT::TopicRule.RepublishAction resource property to the template. - +Describes an action to republish to another topic. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html .PARAMETER RoleArn + The ARN of the IAM role that grants access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Topic + The name of the MQTT topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-topic PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleS3Action.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleS3Action.ps1 index 8359e4021..0183d92e5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleS3Action.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleS3Action.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTTopicRuleS3Action { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.S3Action resource property to the template. + Adds an AWS::IoT::TopicRule.S3Action resource property to the template. Describes an action to write data to an Amazon S3 bucket. .DESCRIPTION Adds an AWS::IoT::TopicRule.S3Action resource property to the template. - +Describes an action to write data to an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html .PARAMETER BucketName + The Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The object key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-key PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM role that grants access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSnsAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSnsAction.ps1 index 4a7284fdb..82516458b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSnsAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSnsAction.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTTopicRuleSnsAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.SnsAction resource property to the template. + Adds an AWS::IoT::TopicRule.SnsAction resource property to the template. Describes an action to publish to an Amazon SNS topic. .DESCRIPTION Adds an AWS::IoT::TopicRule.SnsAction resource property to the template. - +Describes an action to publish to an Amazon SNS topic. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html .PARAMETER MessageFormat + Optional The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats: https://docs.aws.amazon.com/sns/latest/dg/json-formats.html in the *Amazon Simple Notification Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-messageformat PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM role that grants access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER TargetArn + The ARN of the SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-targetarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSqsAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSqsAction.ps1 index 0c88348a0..5f4568589 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSqsAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleSqsAction.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTTopicRuleSqsAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.SqsAction resource property to the template. + Adds an AWS::IoT::TopicRule.SqsAction resource property to the template. Describes an action to publish data to an Amazon SQS queue. .DESCRIPTION Adds an AWS::IoT::TopicRule.SqsAction resource property to the template. - +Describes an action to publish data to an Amazon SQS queue. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html .PARAMETER QueueUrl + The URL of the Amazon SQS queue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-queueurl PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the IAM role that grants access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER UseBase64 + Specifies whether to use Base64 encoding. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-usebase64 PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleStepFunctionsAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleStepFunctionsAction.ps1 index 5dd74f11e..b4739194d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleStepFunctionsAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleStepFunctionsAction.ps1 @@ -1,26 +1,32 @@ function Add-VSIoTTopicRuleStepFunctionsAction { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.StepFunctionsAction resource property to the template. + Adds an AWS::IoT::TopicRule.StepFunctionsAction resource property to the template. Starts execution of a Step Functions state machine. .DESCRIPTION Adds an AWS::IoT::TopicRule.StepFunctionsAction resource property to the template. - +Starts execution of a Step Functions state machine. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html .PARAMETER ExecutionNamePrefix + Optional A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-executionnameprefix PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the role that grants IoT permission to start execution of a state machine "Action":"states:StartExecution". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER StateMachineName + The name of the Step Functions state machine whose execution will be started. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-statemachinename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleTopicRulePayload.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleTopicRulePayload.ps1 index 686435811..e88e8d559 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleTopicRulePayload.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTTopicRuleTopicRulePayload.ps1 @@ -1,16 +1,18 @@ function Add-VSIoTTopicRuleTopicRulePayload { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule.TopicRulePayload resource property to the template. + Adds an AWS::IoT::TopicRule.TopicRulePayload resource property to the template. Describes a rule. .DESCRIPTION Adds an AWS::IoT::TopicRule.TopicRulePayload resource property to the template. - +Describes a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html .PARAMETER Actions + The actions associated with the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-actions DuplicatesAllowed: False ItemType: Action @@ -18,26 +20,36 @@ function Add-VSIoTTopicRuleTopicRulePayload { UpdateType: Mutable .PARAMETER AwsIotSqlVersion + The version of the SQL rules engine to use when evaluating the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description of the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-description PrimitiveType: String UpdateType: Mutable .PARAMETER ErrorAction + The action to take when an error occurs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-erroraction Type: Action UpdateType: Mutable .PARAMETER RuleDisabled + Specifies whether the rule is disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-ruledisabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Sql + The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference: https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference in the *AWS IoT Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationCSVMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationCSVMappingParameters.ps1 index c8b763f3f..9c17e68f6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationCSVMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationCSVMappingParameters.ps1 @@ -1,21 +1,29 @@ function Add-VSKinesisAnalyticsApplicationCSVMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.CSVMappingParameters resource property to the template. + Adds an AWS::KinesisAnalytics::Application.CSVMappingParameters resource property to the template. Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.CSVMappingParameters resource property to the template. +Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: +"name1", "address1" + +"name2", "address2" .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html .PARAMETER RecordRowDelimiter + Row delimiter. For example, in a CSV format, *'n'* is the typical row delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumnDelimiter + Column delimiter. For example, in a CSV format, a comma "," is the typical column delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordcolumndelimiter PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInput.ps1 index 310090e17..290443457 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInput.ps1 @@ -1,41 +1,58 @@ function Add-VSKinesisAnalyticsApplicationInput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.Input resource property to the template. + Adds an AWS::KinesisAnalytics::Application.Input resource property to the template. When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.Input resource property to the template. - +When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html .PARAMETER NamePrefix + Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more as per the InputParallelism count you specified in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-nameprefix PrimitiveType: String UpdateType: Mutable .PARAMETER InputSchema + Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. +Also used to describe the format of the reference data source. + Type: InputSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputschema UpdateType: Mutable .PARAMETER KinesisStreamsInput + If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. +Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. + Type: KinesisStreamsInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisstreamsinput UpdateType: Mutable .PARAMETER KinesisFirehoseInput + If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. +Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. + Type: KinesisFirehoseInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisfirehoseinput UpdateType: Mutable .PARAMETER InputProcessingConfiguration + The InputProcessingConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html. + Type: InputProcessingConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputprocessingconfiguration UpdateType: Mutable .PARAMETER InputParallelism + Describes the number of in-application streams to create. +Data from your source is routed to these in-application input streams. +See Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. + Type: InputParallelism Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputparallelism UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputLambdaProcessor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputLambdaProcessor.ps1 index f10218e80..9b460e6f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputLambdaProcessor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputLambdaProcessor.ps1 @@ -1,21 +1,26 @@ function Add-VSKinesisAnalyticsApplicationInputLambdaProcessor { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.InputLambdaProcessor resource property to the template. + Adds an AWS::KinesisAnalytics::Application.InputLambdaProcessor resource property to the template. An object that contains the Amazon Resource Name (ARN of the AWS Lambda: https://docs.aws.amazon.com/lambda/ function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputLambdaProcessor resource property to the template. - +An object that contains the Amazon Resource Name (ARN of the AWS Lambda: https://docs.aws.amazon.com/lambda/ function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html .PARAMETER ResourceARN + The ARN of the AWS Lambda: https://docs.aws.amazon.com/lambda/ function that operates on records in the stream. +To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda: /general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The ARN of the IAM role that is used to access the AWS Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputParallelism.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputParallelism.ps1 index 95696fadc..a0c6adfa0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputParallelism.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputParallelism.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsApplicationInputParallelism { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.InputParallelism resource property to the template. + Adds an AWS::KinesisAnalytics::Application.InputParallelism resource property to the template. Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputParallelism resource property to the template. - +Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html .PARAMETER Count + Number of in-application streams to create. For more information, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html#cfn-kinesisanalytics-application-inputparallelism-count PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputProcessingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputProcessingConfiguration.ps1 index ca2fafbe2..e6fbcbbdf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputProcessingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputProcessingConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsApplicationInputProcessingConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.InputProcessingConfiguration resource property to the template. + Adds an AWS::KinesisAnalytics::Application.InputProcessingConfiguration resource property to the template. Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda: https://docs.aws.amazon.com/lambda/. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputProcessingConfiguration resource property to the template. - +Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda: https://docs.aws.amazon.com/lambda/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html .PARAMETER InputLambdaProcessor + The InputLambdaProcessor: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html that is used to preprocess the records in the stream before being processed by your application code. + Type: InputLambdaProcessor Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html#cfn-kinesisanalytics-application-inputprocessingconfiguration-inputlambdaprocessor UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputSchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputSchema.ps1 index 432319730..bbdd97c63 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputSchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationInputSchema.ps1 @@ -1,27 +1,35 @@ function Add-VSKinesisAnalyticsApplicationInputSchema { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.InputSchema resource property to the template. + Adds an AWS::KinesisAnalytics::Application.InputSchema resource property to the template. Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.InputSchema resource property to the template. +Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. +Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html .PARAMETER RecordEncoding + Specifies the encoding of the records in the streaming source. For example, UTF-8. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordencoding PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumns + A list of RecordColumn objects. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordcolumns ItemType: RecordColumn UpdateType: Mutable .PARAMETER RecordFormat + Specifies the format of the records on the streaming source. + Type: RecordFormat Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordformat UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationJSONMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationJSONMappingParameters.ps1 index e265fe03b..b7764a1dc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationJSONMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationJSONMappingParameters.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsApplicationJSONMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.JSONMappingParameters resource property to the template. + Adds an AWS::KinesisAnalytics::Application.JSONMappingParameters resource property to the template. Provides additional mapping information when JSON is the record format on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.JSONMappingParameters resource property to the template. - +Provides additional mapping information when JSON is the record format on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html .PARAMETER RecordRowPath + Path to the top-level parent that contains the records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html#cfn-kinesisanalytics-application-jsonmappingparameters-recordrowpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisFirehoseInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisFirehoseInput.ps1 index 4097916d9..fffdff70b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisFirehoseInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisFirehoseInput.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationKinesisFirehoseInput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.KinesisFirehoseInput resource property to the template. + Adds an AWS::KinesisAnalytics::Application.KinesisFirehoseInput resource property to the template. Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.KinesisFirehoseInput resource property to the template. - +Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html .PARAMETER ResourceARN + ARN of the input delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisStreamsInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisStreamsInput.ps1 index 4c5827643..43db2f2f5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisStreamsInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationKinesisStreamsInput.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationKinesisStreamsInput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.KinesisStreamsInput resource property to the template. + Adds an AWS::KinesisAnalytics::Application.KinesisStreamsInput resource property to the template. Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.KinesisStreamsInput resource property to the template. - +Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html .PARAMETER ResourceARN + ARN of the input Amazon Kinesis stream to read. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationMappingParameters.ps1 index 04e2e7412..8904a20b9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationMappingParameters.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.MappingParameters resource property to the template. + Adds an AWS::KinesisAnalytics::Application.MappingParameters resource property to the template. When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.MappingParameters resource property to the template. - +When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html .PARAMETER JSONMappingParameters + Provides additional mapping information when JSON is the record format on the streaming source. + Type: JSONMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-jsonmappingparameters UpdateType: Mutable .PARAMETER CSVMappingParameters + Provides additional mapping information when the record format uses delimiters for example, CSV. + Type: CSVMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-csvmappingparameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputDestinationSchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputDestinationSchema.ps1 index f4d0ce7f6..e24e647d6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputDestinationSchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputDestinationSchema.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsApplicationOutputDestinationSchema { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema resource property to the template. Describes the data format when records are written to the destination. For more information, see Configuring Application Output: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema resource property to the template. - +Describes the data format when records are written to the destination. For more information, see Configuring Application Output: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html .PARAMETER RecordFormatType + Specifies the format of the records on the output stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html#cfn-kinesisanalytics-applicationoutput-destinationschema-recordformattype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput.ps1 index 436677c79..24ec9c6eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationOutputKinesisFirehoseOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput resource property to the template. When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput resource property to the template. - +When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html .PARAMETER ResourceARN + ARN of the destination Amazon Kinesis Firehose delivery stream to write to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput.ps1 index 2bda2a4dc..bc0d58e67 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationOutputKinesisStreamsOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput resource property to the template. When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput resource property to the template. - +When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html .PARAMETER ResourceARN + ARN of the destination Amazon Kinesis stream to write to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputLambdaOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputLambdaOutput.ps1 index 80f5adc37..5611d6b37 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputLambdaOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputLambdaOutput.ps1 @@ -1,21 +1,26 @@ function Add-VSKinesisAnalyticsApplicationOutputLambdaOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput resource property to the template. When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput resource property to the template. - +When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html .PARAMETER ResourceARN + Amazon Resource Name ARN of the destination Lambda function to write to. +To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda: /general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputOutput.ps1 index 4f870f3c5..48ec38a94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationOutputOutput.ps1 @@ -1,36 +1,48 @@ function Add-VSKinesisAnalyticsApplicationOutputOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationOutput.Output resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput.Output resource property to the template. Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationOutput.Output resource property to the template. +Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. +For limits on how many destinations an application can write and other limitations, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html .PARAMETER DestinationSchema + Describes the data format when records are written to the destination. For more information, see Configuring Application Output: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. + Type: DestinationSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-destinationschema UpdateType: Mutable .PARAMETER LambdaOutput + Identifies an AWS Lambda function as the destination. + Type: LambdaOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-lambdaoutput UpdateType: Mutable .PARAMETER KinesisFirehoseOutput + Identifies an Amazon Kinesis Firehose delivery stream as the destination. + Type: KinesisFirehoseOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisfirehoseoutput UpdateType: Mutable .PARAMETER KinesisStreamsOutput + Identifies an Amazon Kinesis stream as the destination. + Type: KinesisStreamsOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisstreamsoutput UpdateType: Mutable .PARAMETER Name + Name of the in-application stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordColumn.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordColumn.ps1 index aff24d24b..146ecaaeb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordColumn.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordColumn.ps1 @@ -1,26 +1,34 @@ function Add-VSKinesisAnalyticsApplicationRecordColumn { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.RecordColumn resource property to the template. + Adds an AWS::KinesisAnalytics::Application.RecordColumn resource property to the template. Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.RecordColumn resource property to the template. +Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. +Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html .PARAMETER Mapping + Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel is JSON. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-mapping PrimitiveType: String UpdateType: Mutable .PARAMETER SqlType + Type of column created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-sqltype PrimitiveType: String UpdateType: Mutable .PARAMETER Name + Name of the column created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordFormat.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordFormat.ps1 index 07ebe9ec1..10ec01d9b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordFormat.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationRecordFormat.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationRecordFormat { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application.RecordFormat resource property to the template. + Adds an AWS::KinesisAnalytics::Application.RecordFormat resource property to the template. Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::Application.RecordFormat resource property to the template. - +Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html .PARAMETER MappingParameters + When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. + Type: MappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-mappingparameters UpdateType: Mutable .PARAMETER RecordFormatType + The type of record format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-recordformattype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters.ps1 index 4251c4a68..af9cf68f5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters.ps1 @@ -1,21 +1,29 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceCSVMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. +Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: +"name1", "address1" + +"name2", "address2" .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html .PARAMETER RecordRowDelimiter + Row delimiter. For example, in a CSV format, *'n'* is the typical row delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumnDelimiter + Column delimiter. For example, in a CSV format, a comma "," is the typical column delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordcolumndelimiter PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters.ps1 index 52890e0fb..ecc76985d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceJSONMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. Provides additional mapping information when JSON is the record format on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. - +Provides additional mapping information when JSON is the record format on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html .PARAMETER RecordRowPath + Path to the top-level parent that contains the records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters-recordrowpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters.ps1 index 18ce1c832..993a19041 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters resource property to the template. When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters resource property to the template. - +When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html .PARAMETER JSONMappingParameters + Provides additional mapping information when JSON is the record format on the streaming source. + Type: JSONMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-jsonmappingparameters UpdateType: Mutable .PARAMETER CSVMappingParameters + Provides additional mapping information when the record format uses delimiters for example, CSV. + Type: CSVMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-csvmappingparameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn.ps1 index 61a2c953e..4d41bf0f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn.ps1 @@ -1,26 +1,34 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordColumn { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn resource property to the template. Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn resource property to the template. +Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. +Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html .PARAMETER Mapping + Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel is JSON. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-mapping PrimitiveType: String UpdateType: Mutable .PARAMETER SqlType + Type of column created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-sqltype PrimitiveType: String UpdateType: Mutable .PARAMETER Name + Name of the column created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat.ps1 index a2103a923..dbfc71e24 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceRecordFormat { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat resource property to the template. Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat resource property to the template. - +Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html .PARAMETER MappingParameters + When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. + Type: MappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-mappingparameters UpdateType: Mutable .PARAMETER RecordFormatType + The type of record format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-recordformattype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource.ps1 index a4d01d7f2..45d8425bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceDataSource { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. Describes the reference data source by providing the source information (S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. - +Describes the reference data source by providing the source information (S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html .PARAMETER ReferenceSchema + Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + Type: ReferenceSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-referenceschema UpdateType: Mutable .PARAMETER TableName + Name of the in-application table to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER S3ReferenceDataSource + Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application. + Type: S3ReferenceDataSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-s3referencedatasource UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema.ps1 index 107f02730..765b4baa3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema.ps1 @@ -1,27 +1,33 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceReferenceSchema { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. - +The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html .PARAMETER RecordEncoding + Specifies the encoding of the records in the reference source. For example, UTF-8. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordencoding PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumns + A list of RecordColumn objects. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordcolumns ItemType: RecordColumn UpdateType: Mutable .PARAMETER RecordFormat + Specifies the format of the records on the reference source. + Type: RecordFormat Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordformat UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource.ps1 index 7dd7f0515..db6143510 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource.ps1 @@ -1,26 +1,34 @@ function Add-VSKinesisAnalyticsApplicationReferenceDataSourceS3ReferenceDataSource { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. .DESCRIPTION Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. +Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. +An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html operation to trigger reloading of data into your application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html .PARAMETER BucketARN + Amazon Resource Name ARN of the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER FileKey + Object key name containing reference data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-filekey PrimitiveType: String UpdateType: Mutable .PARAMETER ReferenceRoleARN + ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-referencerolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationCodeConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationCodeConfiguration.ps1 index ac4ee80c2..64235f617 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationCodeConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationCodeConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsV2ApplicationApplicationCodeConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration resource property to the template. Describes code configuration for a Java-based Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration resource property to the template. - +Describes code configuration for a Java-based Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html .PARAMETER CodeContentType + Specifies whether the code content is in text or zip format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html#cfn-kinesisanalyticsv2-application-applicationcodeconfiguration-codecontenttype PrimitiveType: String UpdateType: Mutable .PARAMETER CodeContent + The location and type of the application code. + Type: CodeContent Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html#cfn-kinesisanalyticsv2-application-applicationcodeconfiguration-codecontent UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationConfiguration.ps1 index 5f33dfdfe..5d924d092 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationConfiguration.ps1 @@ -1,36 +1,46 @@ function Add-VSKinesisAnalyticsV2ApplicationApplicationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration resource property to the template. Specifies the creation parameters for an Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration resource property to the template. - +Specifies the creation parameters for an Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html .PARAMETER ApplicationCodeConfiguration + The code location and type parameters for a Java-based Kinesis Data Analytics application. + Type: ApplicationCodeConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-applicationcodeconfiguration UpdateType: Mutable .PARAMETER EnvironmentProperties + Describes execution properties for a Java-based Kinesis Data Analytics application. + Type: EnvironmentProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-environmentproperties UpdateType: Mutable .PARAMETER FlinkApplicationConfiguration + The creation and update parameters for a Java-based Kinesis Data Analytics application. + Type: FlinkApplicationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-flinkapplicationconfiguration UpdateType: Mutable .PARAMETER SqlApplicationConfiguration + The creation and update parameters for an SQL-based Kinesis Data Analytics application. + Type: SqlApplicationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-sqlapplicationconfiguration UpdateType: Mutable .PARAMETER ApplicationSnapshotConfiguration + Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + Type: ApplicationSnapshotConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-applicationsnapshotconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationSnapshotConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationSnapshotConfiguration.ps1 index abff2619d..4200e05a2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationSnapshotConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationApplicationSnapshotConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationApplicationSnapshotConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration resource property to the template. Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration resource property to the template. - +Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationsnapshotconfiguration.html .PARAMETER SnapshotsEnabled + Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationsnapshotconfiguration.html#cfn-kinesisanalyticsv2-application-applicationsnapshotconfiguration-snapshotsenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCSVMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCSVMappingParameters.ps1 index 655679e94..e4d4ec462 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCSVMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCSVMappingParameters.ps1 @@ -1,21 +1,29 @@ function Add-VSKinesisAnalyticsV2ApplicationCSVMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.CSVMappingParameters resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.CSVMappingParameters resource property to the template. For an SQL-based application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.CSVMappingParameters resource property to the template. +For an SQL-based application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: +"name1", "address1" + +"name2", "address2" .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html .PARAMETER RecordRowDelimiter + The row delimiter. For example, in a CSV format, *'n'* is the typical row delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html#cfn-kinesisanalyticsv2-application-csvmappingparameters-recordrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumnDelimiter + The column delimiter. For example, in a CSV format, a comma "," is the typical column delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html#cfn-kinesisanalyticsv2-application-csvmappingparameters-recordcolumndelimiter PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 index 3a80d440b..197c3a704 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 @@ -1,31 +1,39 @@ function Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration resource property to the template. Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration resource property to the template. - +Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html .PARAMETER ConfigurationType + Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-configurationtype PrimitiveType: String UpdateType: Mutable .PARAMETER CheckpointInterval + Describes the interval in milliseconds between checkpoint operations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-checkpointinterval PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinPauseBetweenCheckpoints + Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing: https://ci.apache.org/projects/flink/flink-docs-stable/ops/state/large_state_tuning.html#tuning-checkpointing in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-minpausebetweencheckpoints PrimitiveType: Integer UpdateType: Mutable .PARAMETER CheckpointingEnabled + Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-checkpointingenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOptionCloudWatchLoggingOption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOptionCloudWatchLoggingOption.ps1 index 490d02b14..468f001e5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOptionCloudWatchLoggingOption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOptionCloudWatchLoggingOption.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOptionCloudWatchLoggingOption { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption resource property to the template. Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption resource property to the template. - +Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption.html .PARAMETER LogStreamARN + The ARN of the CloudWatch log to receive application messages. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption.html#cfn-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption-logstreamarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCodeContent.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCodeContent.ps1 index 4f37c4c5f..507b1fdaf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCodeContent.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCodeContent.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisAnalyticsV2ApplicationCodeContent { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.CodeContent resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.CodeContent resource property to the template. Specifies either the application code, or the location of the application code, for a Java-based Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.CodeContent resource property to the template. - +Specifies either the application code, or the location of the application code, for a Java-based Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html .PARAMETER ZipFileContent + The zip-format code for a Java-based Kinesis Data Analytics application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html#cfn-kinesisanalyticsv2-application-codecontent-zipfilecontent PrimitiveType: String UpdateType: Mutable .PARAMETER S3ContentLocation + Information about the Amazon S3 bucket containing the application code. + Type: S3ContentLocation Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html#cfn-kinesisanalyticsv2-application-codecontent-s3contentlocation UpdateType: Mutable .PARAMETER TextContent + The text-format code for a Java-based Kinesis Data Analytics application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html#cfn-kinesisanalyticsv2-application-codecontent-textcontent PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationEnvironmentProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationEnvironmentProperties.ps1 index 41b4cb7fe..530eb7eab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationEnvironmentProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationEnvironmentProperties.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationEnvironmentProperties { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.EnvironmentProperties resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.EnvironmentProperties resource property to the template. Describes execution properties for a Java-based Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.EnvironmentProperties resource property to the template. - +Describes execution properties for a Java-based Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-environmentproperties.html .PARAMETER PropertyGroups + Describes the execution property groups. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-environmentproperties.html#cfn-kinesisanalyticsv2-application-environmentproperties-propertygroups ItemType: PropertyGroup diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 index 27d0a7264..42d22ef59 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration resource property to the template. Describes configuration parameters for a Java-based Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration resource property to the template. - +Describes configuration parameters for a Java-based Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html .PARAMETER CheckpointConfiguration + Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. + Type: CheckpointConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-checkpointconfiguration UpdateType: Mutable .PARAMETER ParallelismConfiguration + Describes parameters for how an application executes multiple tasks simultaneously. + Type: ParallelismConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-parallelismconfiguration UpdateType: Mutable .PARAMETER MonitoringConfiguration + Describes configuration parameters for Amazon CloudWatch logging for an application. + Type: MonitoringConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-monitoringconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInput.ps1 index 1f0f4f933..18d38ae18 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInput.ps1 @@ -1,41 +1,54 @@ function Add-VSKinesisAnalyticsV2ApplicationInput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.Input resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.Input resource property to the template. When you configure the application input for an SQL-based Amazon Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.Input resource property to the template. - +When you configure the application input for an SQL-based Amazon Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html .PARAMETER NamePrefix + The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more as per the InputParallelism count you specified in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-nameprefix PrimitiveType: String UpdateType: Mutable .PARAMETER InputSchema + Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. +Also used to describe the format of the reference data source. + Type: InputSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-inputschema UpdateType: Mutable .PARAMETER KinesisStreamsInput + If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name ARN. + Type: KinesisStreamsInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-kinesisstreamsinput UpdateType: Mutable .PARAMETER KinesisFirehoseInput + If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN. + Type: KinesisFirehoseInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-kinesisfirehoseinput UpdateType: Mutable .PARAMETER InputProcessingConfiguration + The InputProcessingConfiguration: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_InputProcessingConfiguration.html for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_InputLambdaProcessor.html. + Type: InputProcessingConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-inputprocessingconfiguration UpdateType: Mutable .PARAMETER InputParallelism + Describes the number of in-application streams to create. + Type: InputParallelism Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-inputparallelism UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputLambdaProcessor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputLambdaProcessor.ps1 index f7d5a803f..a3234587a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputLambdaProcessor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputLambdaProcessor.ps1 @@ -1,16 +1,19 @@ function Add-VSKinesisAnalyticsV2ApplicationInputLambdaProcessor { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor resource property to the template. An object that contains the Amazon Resource Name (ARN of the AWS Lambda function that is used to preprocess records in the stream in an SQL-based Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor resource property to the template. - +An object that contains the Amazon Resource Name (ARN of the AWS Lambda function that is used to preprocess records in the stream in an SQL-based Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputlambdaprocessor.html .PARAMETER ResourceARN + The ARN of the AWS Lambda function that operates on records in the stream. +To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputlambdaprocessor.html#cfn-kinesisanalyticsv2-application-inputlambdaprocessor-resourcearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputParallelism.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputParallelism.ps1 index c1762dc31..993b58f5a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputParallelism.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputParallelism.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationInputParallelism { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.InputParallelism resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.InputParallelism resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.InputParallelism resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputparallelism.html .PARAMETER Count + The number of in-application streams to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputparallelism.html#cfn-kinesisanalyticsv2-application-inputparallelism-count PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputProcessingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputProcessingConfiguration.ps1 index 42b3500db..3c69501f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputProcessingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputProcessingConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationInputProcessingConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda: https://docs.aws.amazon.com/lambda/. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda: https://docs.aws.amazon.com/lambda/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputprocessingconfiguration.html .PARAMETER InputLambdaProcessor + The InputLambdaProcessor: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_InputLambdaProcessor.html that is used to preprocess the records in the stream before being processed by your application code. + Type: InputLambdaProcessor Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputprocessingconfiguration.html#cfn-kinesisanalyticsv2-application-inputprocessingconfiguration-inputlambdaprocessor UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputSchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputSchema.ps1 index a094eeeb1..cfa895cf5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputSchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationInputSchema.ps1 @@ -1,27 +1,33 @@ function Add-VSKinesisAnalyticsV2ApplicationInputSchema { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.InputSchema resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.InputSchema resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.InputSchema resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html .PARAMETER RecordEncoding + Specifies the encoding of the records in the streaming source. For example, UTF-8. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordencoding PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumns + A list of RecordColumn objects. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordcolumns ItemType: RecordColumn UpdateType: Mutable .PARAMETER RecordFormat + Specifies the format of the records on the streaming source. + Type: RecordFormat Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordformat UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationJSONMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationJSONMappingParameters.ps1 index 2cdf85530..0c8e2a613 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationJSONMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationJSONMappingParameters.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationJSONMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.JSONMappingParameters resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.JSONMappingParameters resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.JSONMappingParameters resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-jsonmappingparameters.html .PARAMETER RecordRowPath + The path to the top-level parent that contains the records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-jsonmappingparameters.html#cfn-kinesisanalyticsv2-application-jsonmappingparameters-recordrowpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisFirehoseInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisFirehoseInput.ps1 index c09c28977..9631af8cf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisFirehoseInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisFirehoseInput.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationKinesisFirehoseInput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisfirehoseinput.html .PARAMETER ResourceARN + The Amazon Resource Name ARN of the delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisfirehoseinput.html#cfn-kinesisanalyticsv2-application-kinesisfirehoseinput-resourcearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisStreamsInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisStreamsInput.ps1 index 57b6da725..834028908 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisStreamsInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationKinesisStreamsInput.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationKinesisStreamsInput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput resource property to the template. Identifies an Amazon Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput resource property to the template. - +Identifies an Amazon Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisstreamsinput.html .PARAMETER ResourceARN + The ARN of the input Kinesis data stream to read. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisstreamsinput.html#cfn-kinesisanalyticsv2-application-kinesisstreamsinput-resourcearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMappingParameters.ps1 index 5a7852c82..9a0f973c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMappingParameters.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsV2ApplicationMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.MappingParameters resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.MappingParameters resource property to the template. When you configure an SQL-based Amazon Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.MappingParameters resource property to the template. - +When you configure an SQL-based Amazon Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html .PARAMETER JSONMappingParameters + Provides additional mapping information when JSON is the record format on the streaming source. + Type: JSONMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html#cfn-kinesisanalyticsv2-application-mappingparameters-jsonmappingparameters UpdateType: Mutable .PARAMETER CSVMappingParameters + Provides additional mapping information when the record format uses delimiters for example, CSV. + Type: CSVMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html#cfn-kinesisanalyticsv2-application-mappingparameters-csvmappingparameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 index fccfceb96..ae63ebe05 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration resource property to the template. Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring: https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration resource property to the template. - +Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring: https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html .PARAMETER ConfigurationType + Describes whether to use the default CloudWatch logging configuration for an application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-configurationtype PrimitiveType: String UpdateType: Mutable .PARAMETER MetricsLevel + Describes the granularity of the CloudWatch Logs for an application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-metricslevel PrimitiveType: String UpdateType: Mutable .PARAMETER LogLevel + Describes the verbosity of the CloudWatch Logs for an application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-loglevel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputDestinationSchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputDestinationSchema.ps1 index 8413b21ee..74f56600b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputDestinationSchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputDestinationSchema.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationOutputDestinationSchema { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema resource property to the template. Describes the data format when records are written to the destination in an SQL-based Amazon Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema resource property to the template. - +Describes the data format when records are written to the destination in an SQL-based Amazon Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html .PARAMETER RecordFormatType + Specifies the format of the records on the output stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html#cfn-kinesisanalyticsv2-applicationoutput-destinationschema-recordformattype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisFirehoseOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisFirehoseOutput.ps1 index 26fb77278..1a10928de 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisFirehoseOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisFirehoseOutput.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationOutputKinesisFirehoseOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN of the delivery stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN of the delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html .PARAMETER ResourceARN + The ARN of the destination delivery stream to write to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput-resourcearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisStreamsOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisStreamsOutput.ps1 index 4d674f0c6..62742a3b9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisStreamsOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputKinesisStreamsOutput.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationOutputKinesisStreamsOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput resource property to the template. When you configure an SQL-based Amazon Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput resource property to the template. - +When you configure an SQL-based Amazon Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html .PARAMETER ResourceARN + The ARN of the destination Kinesis data stream to write to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput-resourcearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputLambdaOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputLambdaOutput.ps1 index 774fabe9e..65c19159c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputLambdaOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputLambdaOutput.ps1 @@ -1,16 +1,19 @@ function Add-VSKinesisAnalyticsV2ApplicationOutputLambdaOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput resource property to the template. When you configure an SQL-based Amazon Kinesis Data Analytics application's output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN of the Lambda function. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput resource property to the template. - +When you configure an SQL-based Amazon Kinesis Data Analytics application's output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN of the Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html .PARAMETER ResourceARN + The Amazon Resource Name ARN of the destination Lambda function to write to. +To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda: /general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html#cfn-kinesisanalyticsv2-applicationoutput-lambdaoutput-resourcearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputOutput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputOutput.ps1 index 237544ab9..3c2248e12 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputOutput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationOutputOutput.ps1 @@ -1,36 +1,46 @@ function Add-VSKinesisAnalyticsV2ApplicationOutputOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.Output resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.Output resource property to the template. Describes an SQL-based Amazon Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationOutput.Output resource property to the template. - +Describes an SQL-based Amazon Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html .PARAMETER DestinationSchema + Describes the data format when records are written to the destination. + Type: DestinationSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-destinationschema UpdateType: Mutable .PARAMETER LambdaOutput + Identifies an AWS Lambda function as the destination. + Type: LambdaOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-lambdaoutput UpdateType: Mutable .PARAMETER KinesisFirehoseOutput + Identifies an Amazon Kinesis Data Firehose delivery stream as the destination. + Type: KinesisFirehoseOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-kinesisfirehoseoutput UpdateType: Mutable .PARAMETER KinesisStreamsOutput + Identifies an Amazon Kinesis data stream as the destination. + Type: KinesisStreamsOutput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-kinesisstreamsoutput UpdateType: Mutable .PARAMETER Name + The name of the in-application stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 index 59d26d4fd..6618b1351 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 @@ -1,31 +1,39 @@ function Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration resource property to the template. Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution: https://ci.apache.org/projects/flink/flink-docs-stable/dev/parallel.html in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration resource property to the template. - +Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution: https://ci.apache.org/projects/flink/flink-docs-stable/dev/parallel.html in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html .PARAMETER ConfigurationType + Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-configurationtype PrimitiveType: String UpdateType: Mutable .PARAMETER ParallelismPerKPU + Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit KPU used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing: http://aws.amazon.com/kinesis/data-analytics/pricing/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-parallelismperkpu PrimitiveType: Integer UpdateType: Mutable .PARAMETER AutoScalingEnabled + Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-autoscalingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Parallelism + Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_ParallelismConfiguration.html#kinesisanalytics-Type-ParallelismConfiguration-AutoScalingEnabled.html is set to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-parallelism PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationPropertyGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationPropertyGroup.ps1 index fc9844714..60898da5d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationPropertyGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationPropertyGroup.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsV2ApplicationPropertyGroup { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.PropertyGroup resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.PropertyGroup resource property to the template. Property key-value pairs passed into a Java-based Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.PropertyGroup resource property to the template. - +Property key-value pairs passed into a Java-based Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-propertygroup.html .PARAMETER PropertyMap + Describes the value of an application execution property key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-propertygroup.html#cfn-kinesisanalyticsv2-application-propertygroup-propertymap PrimitiveType: Json UpdateType: Mutable .PARAMETER PropertyGroupId + Describes the key of an application execution property key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-propertygroup.html#cfn-kinesisanalyticsv2-application-propertygroup-propertygroupid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordColumn.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordColumn.ps1 index ccb577722..7ff42b30f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordColumn.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordColumn.ps1 @@ -1,26 +1,34 @@ function Add-VSKinesisAnalyticsV2ApplicationRecordColumn { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.RecordColumn resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.RecordColumn resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.RecordColumn resource property to the template. +For an SQL-based Amazon Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. +Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html .PARAMETER Mapping + A reference to the data element in the streaming input or the reference data source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html#cfn-kinesisanalyticsv2-application-recordcolumn-mapping PrimitiveType: String UpdateType: Mutable .PARAMETER SqlType + The type of column created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html#cfn-kinesisanalyticsv2-application-recordcolumn-sqltype PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the column that is created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html#cfn-kinesisanalyticsv2-application-recordcolumn-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordFormat.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordFormat.ps1 index 2a8a31928..2f363419c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordFormat.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationRecordFormat.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsV2ApplicationRecordFormat { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.RecordFormat resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.RecordFormat resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.RecordFormat resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordformat.html .PARAMETER MappingParameters + When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. + Type: MappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordformat.html#cfn-kinesisanalyticsv2-application-recordformat-mappingparameters UpdateType: Mutable .PARAMETER RecordFormatType + The type of record format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordformat.html#cfn-kinesisanalyticsv2-application-recordformat-recordformattype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceCSVMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceCSVMappingParameters.ps1 index bdb239d25..0a7443657 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceCSVMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceCSVMappingParameters.ps1 @@ -1,21 +1,29 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceCSVMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. For an SQL-based application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters resource property to the template. +For an SQL-based application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'n'* as the row delimiter and a comma ("," as the column delimiter: +"name1", "address1" + +"name2", "address2" .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html .PARAMETER RecordRowDelimiter + The row delimiter. For example, in a CSV format, *'n'* is the typical row delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumnDelimiter + The column delimiter. For example, in a CSV format, a comma "," is the typical column delimiter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters-recordcolumndelimiter PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceJSONMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceJSONMappingParameters.ps1 index e60915e89..9dc325f4d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceJSONMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceJSONMappingParameters.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceJSONMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters.html .PARAMETER RecordRowPath + The path to the top-level parent that contains the records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters-recordrowpath PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceMappingParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceMappingParameters.ps1 index 59eed3046..6848280e1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceMappingParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceMappingParameters.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceMappingParameters { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters resource property to the template. When you configure an SQL-based Amazon Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters resource property to the template. - +When you configure an SQL-based Amazon Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters.html .PARAMETER JSONMappingParameters + Provides additional mapping information when JSON is the record format on the streaming source. + Type: JSONMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters-jsonmappingparameters UpdateType: Mutable .PARAMETER CSVMappingParameters + Provides additional mapping information when the record format uses delimiters for example, CSV. + Type: CSVMappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters-csvmappingparameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordColumn.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordColumn.ps1 index c16ab9674..f93a54437 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordColumn.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordColumn.ps1 @@ -1,26 +1,34 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordColumn { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn resource property to the template. +For an SQL-based Amazon Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. +Also used to describe the format of the reference data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html .PARAMETER Mapping + A reference to the data element in the streaming input or the reference data source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn-mapping PrimitiveType: String UpdateType: Mutable .PARAMETER SqlType + The type of column created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn-sqltype PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the column that is created in the in-application input stream or reference table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordFormat.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordFormat.ps1 index d381119f6..c944d347a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordFormat.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordFormat.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceRecordFormat { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html .PARAMETER MappingParameters + When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format such as JSON, CSV, or record fields delimited by some delimiter on the streaming source. + Type: MappingParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordformat-mappingparameters UpdateType: Mutable .PARAMETER RecordFormatType + The type of record format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordformat-recordformattype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceDataSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceDataSource.ps1 index fe7764b5e..eec574b42 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceDataSource.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceDataSource { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html .PARAMETER ReferenceSchema + Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + Type: ReferenceSchema Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-referenceschema UpdateType: Mutable .PARAMETER TableName + The name of the in-application table to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-tablename PrimitiveType: String UpdateType: Immutable .PARAMETER S3ReferenceDataSource + Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_UpdateApplication.html operation to trigger reloading of data into your application. + Type: S3ReferenceDataSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-s3referencedatasource UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceSchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceSchema.ps1 index 7e578b31b..ab367165d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceSchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceSchema.ps1 @@ -1,27 +1,33 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceReferenceSchema { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema resource property to the template. - +For an SQL-based Amazon Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html .PARAMETER RecordEncoding + Specifies the encoding of the records in the streaming source. For example, UTF-8. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referenceschema-recordencoding PrimitiveType: String UpdateType: Mutable .PARAMETER RecordColumns + A list of RecordColumn objects. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referenceschema-recordcolumns ItemType: RecordColumn UpdateType: Mutable .PARAMETER RecordFormat + Specifies the format of the records on the streaming source. + Type: RecordFormat Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referenceschema-recordformat UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceS3ReferenceDataSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceS3ReferenceDataSource.ps1 index d1497c800..51d61ec83 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceS3ReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceS3ReferenceDataSource.ps1 @@ -1,21 +1,27 @@ function Add-VSKinesisAnalyticsV2ApplicationReferenceDataSourceS3ReferenceDataSource { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. For an SQL-based Amazon Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource resource property to the template. +For an SQL-based Amazon Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data. +A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_UpdateApplication.html operation to trigger reloading of data into your application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html .PARAMETER BucketARN + The Amazon Resource Name ARN of the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER FileKey + The object key name containing the reference data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource-filekey PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationS3ContentLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationS3ContentLocation.ps1 index 2ef9ee323..448522486 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationS3ContentLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationS3ContentLocation.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisAnalyticsV2ApplicationS3ContentLocation { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.S3ContentLocation resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.S3ContentLocation resource property to the template. For a Java-based Amazon Kinesis Data Analytics application, provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.S3ContentLocation resource property to the template. - +For a Java-based Amazon Kinesis Data Analytics application, provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html .PARAMETER BucketARN + The Amazon Resource Name ARN for the S3 bucket containing the application code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html#cfn-kinesisanalyticsv2-application-s3contentlocation-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER FileKey + The file key for the object containing the application code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html#cfn-kinesisanalyticsv2-application-s3contentlocation-filekey PrimitiveType: String UpdateType: Mutable .PARAMETER ObjectVersion + The version of the object containing the application code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html#cfn-kinesisanalyticsv2-application-s3contentlocation-objectversion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationSqlApplicationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationSqlApplicationConfiguration.ps1 index bd97c5c41..50e9e8cdd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationSqlApplicationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationSqlApplicationConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisAnalyticsV2ApplicationSqlApplicationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration resource property to the template. + Adds an AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration resource property to the template. Describes the inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration resource property to the template. - +Describes the inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-sqlapplicationconfiguration.html .PARAMETER Inputs + The array of Input: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_Input.html objects describing the input streams used by the application. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-sqlapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-sqlapplicationconfiguration-inputs ItemType: Input diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamBufferingHints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamBufferingHints.ps1 index d9d6d5b68..fe9e63348 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamBufferingHints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamBufferingHints.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamBufferingHints { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.BufferingHints resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.BufferingHints resource property to the template. The BufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data before delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.BufferingHints resource property to the template. - +The BufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data before delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html .PARAMETER IntervalInSeconds + The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the IntervalInSeconds content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER SizeInMBs + The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the SizeInMBs content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions.ps1 index 6957e8ad1..df6616492 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions.ps1 @@ -1,26 +1,34 @@ function Add-VSKinesisFirehoseDeliveryStreamCloudWatchLoggingOptions { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions resource property to the template. The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses for the delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions resource property to the template. - +The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses for the delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html .PARAMETER Enabled + Indicates whether CloudWatch Logs logging is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LogGroupName + The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use. +Conditional. If you enable logging, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname PrimitiveType: String UpdateType: Mutable .PARAMETER LogStreamName + The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery. +Conditional. If you enable logging, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCopyCommand.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCopyCommand.ps1 index cd3d4a1e8..0282833ee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCopyCommand.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamCopyCommand.ps1 @@ -1,26 +1,32 @@ function Add-VSKinesisFirehoseDeliveryStreamCopyCommand { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.CopyCommand resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.CopyCommand resource property to the template. The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.CopyCommand resource property to the template. - +The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html .PARAMETER CopyOptions + Parameters to use with the Amazon Redshift COPY command. For examples, see the CopyOptions content for the CopyCommand: https://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions PrimitiveType: String UpdateType: Mutable .PARAMETER DataTableColumns + A comma-separated list of column names. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns PrimitiveType: String UpdateType: Mutable .PARAMETER DataTableName + The name of the target table. The table must already exist in the database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration.ps1 index 891907f4b..284cfc7f4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration.ps1 @@ -1,31 +1,39 @@ function Add-VSKinesisFirehoseDeliveryStreamDataFormatConversionConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration resource property to the template. Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion: https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration resource property to the template. - +Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion: https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html .PARAMETER Enabled + Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER InputFormatConfiguration + Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-inputformatconfiguration Type: InputFormatConfiguration UpdateType: Mutable .PARAMETER OutputFormatConfiguration + Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-outputformatconfiguration Type: OutputFormatConfiguration UpdateType: Mutable .PARAMETER SchemaConfiguration + Specifies the AWS Glue Data Catalog table that contains the column information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration Type: SchemaConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDeserializer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDeserializer.ps1 index 73c20f27b..c65916a20 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDeserializer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamDeserializer.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamDeserializer { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.Deserializer resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.Deserializer resource property to the template. The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe: https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON and the OpenX JSON SerDe: https://github.com/rcongiu/Hive-JSON-Serde. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.Deserializer resource property to the template. - +The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe: https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON and the OpenX JSON SerDe: https://github.com/rcongiu/Hive-JSON-Serde. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html .PARAMETER HiveJsonSerDe + The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde Type: HiveJsonSerDe UpdateType: Mutable .PARAMETER OpenXJsonSerDe + The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde Type: OpenXJsonSerDe UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints.ps1 index 64111f57e..09eb61dab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints.ps1 @@ -1,21 +1,27 @@ function Add-VSKinesisFirehoseDeliveryStreamElasticsearchBufferingHints { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints resource property to the template. The ElasticsearchBufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data while delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints resource property to the template. +The ElasticsearchBufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose buffers incoming data while delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. +ElasticsearchBufferingHints is the property type for the BufferingHints property of the Amazon Kinesis Data Firehose DeliveryStream ElasticsearchDestinationConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html .PARAMETER IntervalInSeconds + The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the IntervalInSeconds content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER SizeInMBs + The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the SizeInMBs content for the BufferingHints: https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration.ps1 index fc442c30d..047edbcdb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration.ps1 @@ -1,66 +1,88 @@ function Add-VSKinesisFirehoseDeliveryStreamElasticsearchDestinationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration resource property to the template. The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data to. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration resource property to the template. - +The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data to. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html .PARAMETER BufferingHints + Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints Type: ElasticsearchBufferingHints UpdateType: Mutable .PARAMETER CloudWatchLoggingOptions + The Amazon CloudWatch Logs logging options for the delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions Type: CloudWatchLoggingOptions UpdateType: Mutable .PARAMETER DomainARN + The Amazon Resource Name ARN of the Amazon ES domain that Kinesis Data Firehose delivers data to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn PrimitiveType: String UpdateType: Mutable .PARAMETER IndexName + The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname PrimitiveType: String UpdateType: Mutable .PARAMETER IndexRotationPeriod + The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination: https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation in the *Amazon Kinesis Data Firehose Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod PrimitiveType: String UpdateType: Mutable .PARAMETER ProcessingConfiguration + The data processing configuration for the Kinesis Data Firehose delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration Type: ProcessingConfiguration UpdateType: Mutable .PARAMETER RetryOptions + The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions Type: ElasticsearchRetryOptions UpdateType: Mutable .PARAMETER RoleARN + The Amazon Resource Name ARN of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER S3BackupMode + The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service Amazon S3. You can send Amazon S3 all documents all data or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode PrimitiveType: String UpdateType: Mutable .PARAMETER S3Configuration + The S3 bucket where Kinesis Data Firehose backs up incoming data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration Type: S3DestinationConfiguration UpdateType: Mutable .PARAMETER TypeName + The Elasticsearch type name that Amazon ES adds to documents when indexing data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions.ps1 index 276847fac..517763d5b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamElasticsearchRetryOptions { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions resource property to the template. The ElasticsearchRetryOptions property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose can't deliver data to Amazon Elasticsearch Service (Amazon ES. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions resource property to the template. - +The ElasticsearchRetryOptions property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose can't deliver data to Amazon Elasticsearch Service (Amazon ES. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html .PARAMETER DurationInSeconds + After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery including the first attempt. If Kinesis Data Firehose can't deliver the data within the specified time, it writes the data to the backup S3 bucket. For valid values, see the DurationInSeconds content for the ElasticsearchRetryOptions: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration.ps1 index afaf00459..0576c8258 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamEncryptionConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration resource property to the template. The EncryptionConfiguration property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses when delivering data to Amazon Simple Storage Service (Amazon S3. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration resource property to the template. - +The EncryptionConfiguration property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose uses when delivering data to Amazon Simple Storage Service (Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html .PARAMETER KMSEncryptionConfig + The AWS Key Management Service AWS KMS encryption key that Amazon S3 uses to encrypt your data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig Type: KMSEncryptionConfig UpdateType: Mutable .PARAMETER NoEncryptionConfig + Disables encryption. For valid values, see the NoEncryptionConfig content for the EncryptionConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration.ps1 index 36e48794a..5428332a0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration.ps1 @@ -1,71 +1,95 @@ function Add-VSKinesisFirehoseDeliveryStreamExtendedS3DestinationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration resource property to the template. The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration resource property to the template. - +The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html .PARAMETER BucketARN + The Amazon Resource Name ARN of the Amazon S3 bucket. For constraints, see ExtendedS3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER BufferingHints + The buffering option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints Type: BufferingHints UpdateType: Mutable .PARAMETER CloudWatchLoggingOptions + The Amazon CloudWatch logging options for your delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions Type: CloudWatchLoggingOptions UpdateType: Mutable .PARAMETER CompressionFormat + The compression format. If no value is specified, the default is UNCOMPRESSED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat PrimitiveType: String UpdateType: Mutable .PARAMETER DataFormatConversionConfiguration + The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration Type: DataFormatConversionConfiguration UpdateType: Mutable .PARAMETER EncryptionConfiguration + The encryption configuration for the Kinesis Data Firehose delivery stream. The default value is NoEncryption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration Type: EncryptionConfiguration UpdateType: Mutable .PARAMETER ErrorOutputPrefix + A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-erroroutputprefix PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files. For more information, see ExtendedS3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER ProcessingConfiguration + The data processing configuration for the Kinesis Data Firehose delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration Type: ProcessingConfiguration UpdateType: Mutable .PARAMETER RoleARN + The Amazon Resource Name ARN of the AWS credentials. For constraints, see ExtendedS3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER S3BackupConfiguration + The configuration for backup in Amazon S3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration Type: S3DestinationConfiguration UpdateType: Mutable .PARAMETER S3BackupMode + The Amazon S3 backup mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe.ps1 index be3975bae..71a33d624 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamHiveJsonSerDe { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe resource property to the template. The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe resource property to the template. - +The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html .PARAMETER TimestampFormats + Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat: https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration.ps1 index 4fa66eb92..95fb96977 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamInputFormatConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration resource property to the template. Specifies the deserializer you want to use to convert the format of the input data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration resource property to the template. - +Specifies the deserializer you want to use to convert the format of the input data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html .PARAMETER Deserializer + Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer Type: Deserializer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig.ps1 index 1d65dfff0..6e72f2862 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamKMSEncryptionConfig { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig resource property to the template. The KMSEncryptionConfig property type specifies the AWS Key Management Service (AWS KMS encryption key that Amazon Simple Storage Service (Amazon S3 uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig resource property to the template. - +The KMSEncryptionConfig property type specifies the AWS Key Management Service (AWS KMS encryption key that Amazon Simple Storage Service (Amazon S3 uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html .PARAMETER AWSKMSKeyARN + The Amazon Resource Name ARN of the AWS KMS encryption key that Amazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream. The key must belong to the same region as the destination S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration.ps1 index 81e2f7cf8..b55b9a6eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamKinesisStreamSourceConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration resource property to the template. The KinesisStreamSourceConfiguration property type specifies the stream and role Amazon Resource Names (ARNs for a Kinesis stream used as the source for a delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration resource property to the template. - +The KinesisStreamSourceConfiguration property type specifies the stream and role Amazon Resource Names (ARNs for a Kinesis stream used as the source for a delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html .PARAMETER KinesisStreamARN + The ARN of the source Kinesis data stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The ARN of the role that provides access to the source Kinesis data stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe.ps1 index 246cc54f3..df53879c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe resource property to the template. The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe resource property to the template. - +The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html .PARAMETER CaseInsensitive + When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ColumnToJsonKeyMappings + Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings DuplicatesAllowed: False PrimitiveItemType: String @@ -23,6 +27,9 @@ function Add-VSKinesisFirehoseDeliveryStreamOpenXJsonSerDe { UpdateType: Mutable .PARAMETER ConvertDotsInJsonKeysToUnderscores + When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option. +The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOrcSerDe.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOrcSerDe.ps1 index e397c6b9e..486437d12 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOrcSerDe.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOrcSerDe.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamOrcSerDe { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.OrcSerDe resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.OrcSerDe resource property to the template. A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC: https://orc.apache.org/docs/. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.OrcSerDe resource property to the template. - +A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC: https://orc.apache.org/docs/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html .PARAMETER BlockSizeBytes + The Hadoop Distributed File System HDFS block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes PrimitiveType: Integer UpdateType: Mutable .PARAMETER BloomFilterColumns + The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns DuplicatesAllowed: False PrimitiveItemType: String @@ -23,41 +27,59 @@ function Add-VSKinesisFirehoseDeliveryStreamOrcSerDe { UpdateType: Mutable .PARAMETER BloomFilterFalsePositiveProbability + The Bloom filter false positive probability FPP. The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability PrimitiveType: Double UpdateType: Mutable .PARAMETER Compression + The compression code to use over data blocks. The default is SNAPPY. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-compression PrimitiveType: String UpdateType: Mutable .PARAMETER DictionaryKeyThreshold + Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold PrimitiveType: Double UpdateType: Mutable .PARAMETER EnablePadding + Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding PrimitiveType: Boolean UpdateType: Mutable .PARAMETER FormatVersion + The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-formatversion PrimitiveType: String UpdateType: Mutable .PARAMETER PaddingTolerance + A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size. +For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task. +Kinesis Data Firehose ignores this parameter when EnablePadding is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance PrimitiveType: Double UpdateType: Mutable .PARAMETER RowIndexStride + The number of rows between index entries. The default is 10,000 and the minimum is 1,000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride PrimitiveType: Integer UpdateType: Mutable .PARAMETER StripeSizeBytes + The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration.ps1 index eb83701dd..6acc961c9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamOutputFormatConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration resource property to the template. Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration resource property to the template. - +Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html .PARAMETER Serializer + Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer Type: Serializer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 index a1e552c30..9400a7ef4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 @@ -1,41 +1,53 @@ function Add-VSKinesisFirehoseDeliveryStreamParquetSerDe { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ParquetSerDe resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ParquetSerDe resource property to the template. A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet: https://parquet.apache.org/documentation/latest/. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ParquetSerDe resource property to the template. - +A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet: https://parquet.apache.org/documentation/latest/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html .PARAMETER BlockSizeBytes + The Hadoop Distributed File System HDFS block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes PrimitiveType: Integer UpdateType: Mutable .PARAMETER Compression + The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression PrimitiveType: String UpdateType: Mutable .PARAMETER EnableDictionaryCompression + Indicates whether to enable dictionary compression. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MaxPaddingBytes + The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes PrimitiveType: Integer UpdateType: Mutable .PARAMETER PageSizeBytes + The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit in terms of compression and encoding. The minimum value is 64 KiB and the default is 1 MiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes PrimitiveType: Integer UpdateType: Mutable .PARAMETER WriterVersion + Indicates the version of row format to output. The possible values are V1 and V2. The default is V1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration.ps1 index fafc9783f..5e233d951 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamProcessingConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration resource property to the template. The ProcessingConfiguration property configures data processing for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration resource property to the template. - +The ProcessingConfiguration property configures data processing for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html .PARAMETER Enabled + Indicates whether data processing is enabled true or disabled false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Processors + The data processors. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors DuplicatesAllowed: False ItemType: Processor diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessor.ps1 index 9be740cc2..735194e4b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessor.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamProcessor { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.Processor resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.Processor resource property to the template. The Processor property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.Processor resource property to the template. - +The Processor property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html .PARAMETER Parameters + The processor parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-parameters DuplicatesAllowed: False ItemType: ProcessorParameter @@ -18,6 +20,8 @@ function Add-VSKinesisFirehoseDeliveryStreamProcessor { UpdateType: Mutable .PARAMETER Type + The type of processor. Valid values: Lambda. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessorParameter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessorParameter.ps1 index e92438e70..33e25a8d1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessorParameter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamProcessorParameter.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamProcessorParameter { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.ProcessorParameter resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.ProcessorParameter resource property to the template. The ProcessorParameter property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.ProcessorParameter resource property to the template. - +The ProcessorParameter property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html .PARAMETER ParameterName + The name of the parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametername PrimitiveType: String UpdateType: Mutable .PARAMETER ParameterValue + The parameter value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration.ps1 index 25b5fc2be..c95723f06 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration.ps1 @@ -1,51 +1,67 @@ function Add-VSKinesisFirehoseDeliveryStreamRedshiftDestinationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration resource property to the template. The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration resource property to the template. - +The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html .PARAMETER CloudWatchLoggingOptions + The CloudWatch logging options for your delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions Type: CloudWatchLoggingOptions UpdateType: Mutable .PARAMETER ClusterJDBCURL + The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl PrimitiveType: String UpdateType: Mutable .PARAMETER CopyCommand + Configures the Amazon Redshift COPY command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand Type: CopyCommand UpdateType: Mutable .PARAMETER Password + The password for the Amazon Redshift user that you specified in the Username property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password PrimitiveType: String UpdateType: Mutable .PARAMETER ProcessingConfiguration + The data processing configuration for the Kinesis Data Firehose delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration Type: ProcessingConfiguration UpdateType: Mutable .PARAMETER RoleARN + The ARN of the AWS Identity and Access Management IAM role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS if you enable data encryption. For more information, see Grant Kinesis Data Firehose Access to an Amazon Redshift Destination: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-rs in the *Amazon Kinesis Data Firehose Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER S3Configuration + The S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the bucket, Kinesis Data Firehose uses the COPY command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specify SNAPPY or ZIP because the Amazon Redshift COPY command doesn't support them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration Type: S3DestinationConfiguration UpdateType: Mutable .PARAMETER Username + The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have INSERT privileges for copying data from the Amazon S3 bucket to the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration.ps1 index e8c9c9745..80a407632 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration.ps1 @@ -1,51 +1,67 @@ function Add-VSKinesisFirehoseDeliveryStreamS3DestinationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration resource property to the template. The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3 destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration resource property to the template. - +The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3 destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose delivers data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html .PARAMETER BucketARN + The Amazon Resource Name ARN of the Amazon S3 bucket to send data to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER BufferingHints + Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints Type: BufferingHints UpdateType: Mutable .PARAMETER CloudWatchLoggingOptions + The CloudWatch logging options for your delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions Type: CloudWatchLoggingOptions UpdateType: Mutable .PARAMETER CompressionFormat + The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the CompressionFormat content for the S3DestinationConfiguration: https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html data type in the *Amazon Kinesis Data Firehose API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionConfiguration + Configures Amazon Simple Storage Service Amazon S3 server-side encryption. Kinesis Data Firehose uses AWS Key Management Service AWS KMS to encrypt the data that it delivers to your Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration Type: EncryptionConfiguration UpdateType: Mutable .PARAMETER ErrorOutputPrefix + A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-erroroutputprefix PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. The prefix helps you identify the files that Kinesis Data Firehose delivered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The ARN of an AWS Identity and Access Management IAM role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS if you enable data encryption. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 in the *Amazon Kinesis Data Firehose Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration.ps1 index 574f1f224..b53fb4d01 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration.ps1 @@ -1,41 +1,53 @@ function Add-VSKinesisFirehoseDeliveryStreamSchemaConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration resource property to the template. Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration resource property to the template. - +Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html .PARAMETER CatalogId + The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName + Specifies the name of the AWS Glue database that contains the schema for the output data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER Region + If you don't specify an AWS Region, the default is the current Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER TableName + Specifies the AWS Glue table that contains the column information that constitutes your data schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER VersionId + Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSerializer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSerializer.ps1 index 912820f37..ba0b71432 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSerializer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSerializer.ps1 @@ -1,21 +1,25 @@ function Add-VSKinesisFirehoseDeliveryStreamSerializer { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.Serializer resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.Serializer resource property to the template. The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html and the Parquet SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.Serializer resource property to the template. - +The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html and the Parquet SerDe: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html .PARAMETER OrcSerDe + A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC: https://orc.apache.org/docs/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-orcserde Type: OrcSerDe UpdateType: Mutable .PARAMETER ParquetSerDe + A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet: https://parquet.apache.org/documentation/latest/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-parquetserde Type: ParquetSerDe UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration.ps1 index c718d202f..e7e35469c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration.ps1 @@ -1,56 +1,74 @@ function Add-VSKinesisFirehoseDeliveryStreamSplunkDestinationConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration resource property to the template. The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream. .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration resource property to the template. - +The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html .PARAMETER CloudWatchLoggingOptions + The Amazon CloudWatch logging options for your delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions Type: CloudWatchLoggingOptions UpdateType: Mutable .PARAMETER HECAcknowledgmentTimeoutInSeconds + The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER HECEndpoint + The HTTP Event Collector HEC endpoint to which Kinesis Data Firehose sends your data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint PrimitiveType: String UpdateType: Mutable .PARAMETER HECEndpointType + This type can be either Raw or Event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER HECToken + This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken PrimitiveType: String UpdateType: Mutable .PARAMETER ProcessingConfiguration + The data processing configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration Type: ProcessingConfiguration UpdateType: Mutable .PARAMETER RetryOptions + The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions Type: SplunkRetryOptions UpdateType: Mutable .PARAMETER S3BackupMode + Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode PrimitiveType: String UpdateType: Mutable .PARAMETER S3Configuration + The configuration for the backup Amazon S3 location. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration Type: S3DestinationConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions.ps1 index 821a2a6fe..75ac8f80d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSKinesisFirehoseDeliveryStreamSplunkRetryOptions { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions resource property to the template. + Adds an AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions resource property to the template. The SplunkRetryOptions property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk .DESCRIPTION Adds an AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions resource property to the template. - +The SplunkRetryOptions property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html .PARAMETER DurationInSeconds + The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisStreamStreamEncryption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisStreamStreamEncryption.ps1 index d438a6ff6..6d955c0a5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisStreamStreamEncryption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisStreamStreamEncryption.ps1 @@ -1,21 +1,36 @@ function Add-VSKinesisStreamStreamEncryption { <# .SYNOPSIS - Adds an AWS::Kinesis::Stream.StreamEncryption resource property to the template. + Adds an AWS::Kinesis::Stream.StreamEncryption resource property to the template. Enables or updates server-side encryption using an AWS KMS key for a specified stream. .DESCRIPTION Adds an AWS::Kinesis::Stream.StreamEncryption resource property to the template. +Enables or updates server-side encryption using an AWS KMS key for a specified stream. +Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream. + +API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period. + +Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html .PARAMETER EncryptionType + The encryption type to use. The only valid value is KMS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-encryptiontype PrimitiveType: String UpdateType: Mutable .PARAMETER KeyId + The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis. ++ Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 ++ Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName ++ Globally unique key ID example: 12345678-1234-1234-1234-123456789012 ++ Alias name example: alias/MyAliasName ++ Master key owned by Kinesis Data Streams: alias/aws/kinesis + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-keyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsAdmins.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsAdmins.ps1 index e05318ad1..6bc02b3ac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsAdmins.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsAdmins.ps1 @@ -1,11 +1,11 @@ function Add-VSLakeFormationDataLakeSettingsAdmins { <# .SYNOPSIS - Adds an AWS::LakeFormation::DataLakeSettings.Admins resource property to the template. + Adds an AWS::LakeFormation::DataLakeSettings.Admins resource property to the template. A list of AWS Lake Formation principals. .DESCRIPTION Adds an AWS::LakeFormation::DataLakeSettings.Admins resource property to the template. - +A list of AWS Lake Formation principals. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-admins.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsDataLakePrincipal.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsDataLakePrincipal.ps1 index 8eb785e5f..d3e841211 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsDataLakePrincipal.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationDataLakeSettingsDataLakePrincipal.ps1 @@ -1,16 +1,18 @@ function Add-VSLakeFormationDataLakeSettingsDataLakePrincipal { <# .SYNOPSIS - Adds an AWS::LakeFormation::DataLakeSettings.DataLakePrincipal resource property to the template. + Adds an AWS::LakeFormation::DataLakeSettings.DataLakePrincipal resource property to the template. The AWS Lake Formation principal. .DESCRIPTION Adds an AWS::LakeFormation::DataLakeSettings.DataLakePrincipal resource property to the template. - +The AWS Lake Formation principal. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-datalakeprincipal.html .PARAMETER DataLakePrincipalIdentifier + An identifier for the AWS Lake Formation principal. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-datalakeprincipal.html#cfn-lakeformation-datalakesettings-datalakeprincipal-datalakeprincipalidentifier PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLakePrincipal.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLakePrincipal.ps1 index 942afd625..baa4fea3e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLakePrincipal.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLakePrincipal.ps1 @@ -1,16 +1,18 @@ function Add-VSLakeFormationPermissionsDataLakePrincipal { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.DataLakePrincipal resource property to the template. + Adds an AWS::LakeFormation::Permissions.DataLakePrincipal resource property to the template. The AWS Lake Formation principal. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.DataLakePrincipal resource property to the template. - +The AWS Lake Formation principal. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalakeprincipal.html .PARAMETER DataLakePrincipalIdentifier + An identifier for the AWS Lake Formation principal. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalakeprincipal.html#cfn-lakeformation-permissions-datalakeprincipal-datalakeprincipalidentifier PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDatabaseResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDatabaseResource.ps1 index 8e4563a08..6d1c1ea0f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDatabaseResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDatabaseResource.ps1 @@ -1,16 +1,18 @@ function Add-VSLakeFormationPermissionsDatabaseResource { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.DatabaseResource resource property to the template. + Adds an AWS::LakeFormation::Permissions.DatabaseResource resource property to the template. A structure for the database object. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.DatabaseResource resource property to the template. - +A structure for the database object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html .PARAMETER Name + The name of the database resource. Unique to the Data Catalog. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html#cfn-lakeformation-permissions-databaseresource-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsResource.ps1 index 6b301faa9..86308ae29 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsResource.ps1 @@ -1,21 +1,25 @@ function Add-VSLakeFormationPermissionsResource { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.Resource resource property to the template. + Adds an AWS::LakeFormation::Permissions.Resource resource property to the template. A structure for the resource. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.Resource resource property to the template. - +A structure for the resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html .PARAMETER TableResource + A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. + Type: TableResource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-tableresource UpdateType: Mutable .PARAMETER DatabaseResource + A structure for the database object. + Type: DatabaseResource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-databaseresource UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableResource.ps1 index e2de745b0..6a21f5c23 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableResource.ps1 @@ -1,21 +1,25 @@ function Add-VSLakeFormationPermissionsTableResource { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.TableResource resource property to the template. + Adds an AWS::LakeFormation::Permissions.TableResource resource property to the template. A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.TableResource resource property to the template. - +A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html .PARAMETER DatabaseName + The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasAliasRoutingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasAliasRoutingConfiguration.ps1 index e8d4f45e0..b6277e8c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasAliasRoutingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasAliasRoutingConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaAliasAliasRoutingConfiguration { <# .SYNOPSIS - Adds an AWS::Lambda::Alias.AliasRoutingConfiguration resource property to the template. + Adds an AWS::Lambda::Alias.AliasRoutingConfiguration resource property to the template. The traffic-shifting: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html configuration of a Lambda function alias. .DESCRIPTION Adds an AWS::Lambda::Alias.AliasRoutingConfiguration resource property to the template. - +The traffic-shifting: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html configuration of a Lambda function alias. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html .PARAMETER AdditionalVersionWeights + The name of the second alias, and the percentage of traffic that's routed to it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html#cfn-lambda-alias-aliasroutingconfiguration-additionalversionweights DuplicatesAllowed: False ItemType: VersionWeight diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 index 1b3fbe5e8..9920b2bec 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 @@ -1,21 +1,25 @@ function Add-VSLambdaAliasVersionWeight { <# .SYNOPSIS - Adds an AWS::Lambda::Alias.VersionWeight resource property to the template. + Adds an AWS::Lambda::Alias.VersionWeight resource property to the template. The traffic-shifting: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html configuration of a Lambda function alias. .DESCRIPTION Adds an AWS::Lambda::Alias.VersionWeight resource property to the template. - +The traffic-shifting: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html configuration of a Lambda function alias. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html .PARAMETER FunctionVersion + The name of the second alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion PrimitiveType: String UpdateType: Mutable .PARAMETER FunctionWeight + The percentage of traffic that's routed to the second alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 index d5e9907ca..b105890ee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 @@ -1,31 +1,43 @@ function Add-VSLambdaFunctionCode { <# .SYNOPSIS - Adds an AWS::Lambda::Function.Code resource property to the template. + Adds an AWS::Lambda::Function.Code resource property to the template. The deployment package for a Lambda function. For all runtimes, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. .DESCRIPTION Adds an AWS::Lambda::Function.Code resource property to the template. +The deployment package for a Lambda function. For all runtimes, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. +Changes to a deployment package in Amazon S3 are not detected automatically during stack updates. To update the function code, change the object key or version in the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html .PARAMETER S3Bucket + An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket PrimitiveType: String UpdateType: Mutable .PARAMETER S3Key + The Amazon S3 key of the deployment package. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key PrimitiveType: String UpdateType: Mutable .PARAMETER S3ObjectVersion + For versioned objects, the version of the deployment package object to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion PrimitiveType: String UpdateType: Mutable .PARAMETER ZipFile + Node.js and Python The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package: https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html. For the Handler property, the first part of the handler identifier must be index. For example, index.handler. +Your source code can contain up to 4096 characters. For JSON, you must escape quotes and special characters such as newline n with a backslash. +If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module cfn-module that simplifies sending responses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 index 0d3a40718..9ac87b4ef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaFunctionDeadLetterConfig { <# .SYNOPSIS - Adds an AWS::Lambda::Function.DeadLetterConfig resource property to the template. + Adds an AWS::Lambda::Function.DeadLetterConfig resource property to the template. The dead letter queue: https://docs.aws.amazon.com/lambda/latest/dg/dlq.html for failed asynchronous invocations. .DESCRIPTION Adds an AWS::Lambda::Function.DeadLetterConfig resource property to the template. - +The dead letter queue: https://docs.aws.amazon.com/lambda/latest/dg/dlq.html for failed asynchronous invocations. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html .PARAMETER TargetArn + The Amazon Resource Name ARN of an Amazon SQS queue or Amazon SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionEnvironment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionEnvironment.ps1 index f8e6f6422..f219d023a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionEnvironment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionEnvironment.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaFunctionEnvironment { <# .SYNOPSIS - Adds an AWS::Lambda::Function.Environment resource property to the template. + Adds an AWS::Lambda::Function.Environment resource property to the template. A function's environment variable settings. .DESCRIPTION Adds an AWS::Lambda::Function.Environment resource property to the template. - +A function's environment variable settings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html .PARAMETER Variables + Environment variable key-value pairs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html#cfn-lambda-function-environment-variables DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 index a389eaf74..cbcca16ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaFunctionTracingConfig { <# .SYNOPSIS - Adds an AWS::Lambda::Function.TracingConfig resource property to the template. + Adds an AWS::Lambda::Function.TracingConfig resource property to the template. The function's AWS X-Ray tracing configuration. .DESCRIPTION Adds an AWS::Lambda::Function.TracingConfig resource property to the template. - +The function's AWS X-Ray tracing configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html .PARAMETER Mode + The tracing mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html#cfn-lambda-function-tracingconfig-mode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 index e334872d7..492459112 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaFunctionVpcConfig { <# .SYNOPSIS - Adds an AWS::Lambda::Function.VpcConfig resource property to the template. + Adds an AWS::Lambda::Function.VpcConfig resource property to the template. The VPC security groups and subnets that are attached to a Lambda function. .DESCRIPTION Adds an AWS::Lambda::Function.VpcConfig resource property to the template. - +The VPC security groups and subnets that are attached to a Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html .PARAMETER SecurityGroupIds + A list of VPC security groups IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-securitygroupids DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSLambdaFunctionVpcConfig { UpdateType: Mutable .PARAMETER SubnetIds + A list of VPC subnet IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-subnetids DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaLayerVersionContent.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaLayerVersionContent.ps1 index 2f1c44b1d..cb45917af 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaLayerVersionContent.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaLayerVersionContent.ps1 @@ -1,26 +1,32 @@ function Add-VSLambdaLayerVersionContent { <# .SYNOPSIS - Adds an AWS::Lambda::LayerVersion.Content resource property to the template. + Adds an AWS::Lambda::LayerVersion.Content resource property to the template. A ZIP archive that contains the contents of an AWS Lambda layer: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html. .DESCRIPTION Adds an AWS::Lambda::LayerVersion.Content resource property to the template. - +A ZIP archive that contains the contents of an AWS Lambda layer: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html .PARAMETER S3ObjectVersion + For versioned objects, the version of the layer archive object to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion PrimitiveType: String UpdateType: Immutable .PARAMETER S3Bucket + The Amazon S3 bucket of the layer archive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3bucket PrimitiveType: String UpdateType: Immutable .PARAMETER S3Key + The Amazon S3 key of the layer archive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3key PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 index e3251802e..0c5836fdc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 @@ -1,31 +1,39 @@ function Add-VSLogsMetricFilterMetricTransformation { <# .SYNOPSIS - Adds an AWS::Logs::MetricFilter.MetricTransformation resource property to the template. + Adds an AWS::Logs::MetricFilter.MetricTransformation resource property to the template. MetricTransformation is a property of the AWS::Logs::MetricFilter resource that describes how to transform log streams into a CloudWatch metric. .DESCRIPTION Adds an AWS::Logs::MetricFilter.MetricTransformation resource property to the template. - +MetricTransformation is a property of the AWS::Logs::MetricFilter resource that describes how to transform log streams into a CloudWatch metric. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html .PARAMETER DefaultValue + Optional The value to emit when a filter pattern does not match a log event. This value can be null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-defaultvalue PrimitiveType: Double UpdateType: Mutable .PARAMETER MetricName + The name of the CloudWatch metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER MetricNamespace + The namespace of the CloudWatch metric. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricnamespace PrimitiveType: String UpdateType: Mutable .PARAMETER MetricValue + The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like Error, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $ followed by the name of the field that you specified in the filter pattern, such as $size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricvalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 index 6be5dd522..b23eb722f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 @@ -1,38 +1,48 @@ function Add-VSMSKClusterBrokerNodeGroupInfo { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.BrokerNodeGroupInfo resource property to the template. + Adds an AWS::MSK::Cluster.BrokerNodeGroupInfo resource property to the template. The setup to be used for brokers in the cluster. .DESCRIPTION Adds an AWS::MSK::Cluster.BrokerNodeGroupInfo resource property to the template. - +The setup to be used for brokers in the cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html .PARAMETER SecurityGroups + The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-securitygroups UpdateType: Immutable .PARAMETER ClientSubnets + The list of subnets to connect to in the client virtual private cloud VPC. AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-clientsubnets UpdateType: Immutable .PARAMETER StorageInfo + Contains information about storage volumes attached to MSK broker nodes. + Type: StorageInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-storageinfo UpdateType: Immutable .PARAMETER BrokerAZDistribution + The distribution of broker nodes across Availability Zones. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-brokerazdistribution PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceType + The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-instancetype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterClientAuthentication.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterClientAuthentication.ps1 index a3255a795..448a4993f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterClientAuthentication.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterClientAuthentication.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterClientAuthentication { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.ClientAuthentication resource property to the template. + Adds an AWS::MSK::Cluster.ClientAuthentication resource property to the template. Includes information related to client authentication. .DESCRIPTION Adds an AWS::MSK::Cluster.ClientAuthentication resource property to the template. - +Includes information related to client authentication. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-clientauthentication.html .PARAMETER Tls + Details for client authentication using TLS. + Type: Tls Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-clientauthentication.html#cfn-msk-cluster-clientauthentication-tls UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterConfigurationInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterConfigurationInfo.ps1 index 50532c221..91d65b8de 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterConfigurationInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterConfigurationInfo.ps1 @@ -1,21 +1,25 @@ function Add-VSMSKClusterConfigurationInfo { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.ConfigurationInfo resource property to the template. + Adds an AWS::MSK::Cluster.ConfigurationInfo resource property to the template. Specifies the Amazon MSK configuration to use for the brokers. .DESCRIPTION Adds an AWS::MSK::Cluster.ConfigurationInfo resource property to the template. - +Specifies the Amazon MSK configuration to use for the brokers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-configurationinfo.html .PARAMETER Revision + The revision of the Amazon MSK configuration to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-configurationinfo.html#cfn-msk-cluster-configurationinfo-revision PrimitiveType: Integer UpdateType: Immutable .PARAMETER Arn + The Amazon Resource Name ARN of the MSK configuration to use. For example, arn:aws:kafka:us-east-1:123456789012:configuration/example-configuration-name/abcdabcd-1234-abcd-1234-abcd123e8e8e-1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-configurationinfo.html#cfn-msk-cluster-configurationinfo-arn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEBSStorageInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEBSStorageInfo.ps1 index 9efecef56..ec47aa978 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEBSStorageInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEBSStorageInfo.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterEBSStorageInfo { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.EBSStorageInfo resource property to the template. + Adds an AWS::MSK::Cluster.EBSStorageInfo resource property to the template. Contains information about the EBS storage volumes attached to brokers. .DESCRIPTION Adds an AWS::MSK::Cluster.EBSStorageInfo resource property to the template. - +Contains information about the EBS storage volumes attached to brokers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-ebsstorageinfo.html .PARAMETER VolumeSize + The size in GiB of the EBS volume for the data drive on each broker node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-ebsstorageinfo.html#cfn-msk-cluster-ebsstorageinfo-volumesize PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionAtRest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionAtRest.ps1 index 5a029fac2..b5718e0b2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionAtRest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionAtRest.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterEncryptionAtRest { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.EncryptionAtRest resource property to the template. + Adds an AWS::MSK::Cluster.EncryptionAtRest resource property to the template. The data volume encryption details. .DESCRIPTION Adds an AWS::MSK::Cluster.EncryptionAtRest resource property to the template. - +The data volume encryption details. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionatrest.html .PARAMETER DataVolumeKMSKeyId + The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it on your behalf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionatrest.html#cfn-msk-cluster-encryptionatrest-datavolumekmskeyid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInTransit.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInTransit.ps1 index 93913475b..555705ebe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInTransit.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInTransit.ps1 @@ -1,21 +1,29 @@ function Add-VSMSKClusterEncryptionInTransit { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.EncryptionInTransit resource property to the template. + Adds an AWS::MSK::Cluster.EncryptionInTransit resource property to the template. The settings for encrypting data in transit. .DESCRIPTION Adds an AWS::MSK::Cluster.EncryptionInTransit resource property to the template. - +The settings for encrypting data in transit. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html .PARAMETER ClientBroker + Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. ++ TLS means that client-broker communication is enabled with TLS only. ++ TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. ++ PLAINTEXT means that client-broker communication is enabled in plaintext only. +The default value is TLS_PLAINTEXT. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html#cfn-msk-cluster-encryptionintransit-clientbroker PrimitiveType: String UpdateType: Immutable .PARAMETER InCluster + When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html#cfn-msk-cluster-encryptionintransit-incluster PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInfo.ps1 index 4a56a004f..51adcf033 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterEncryptionInfo.ps1 @@ -1,21 +1,25 @@ function Add-VSMSKClusterEncryptionInfo { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.EncryptionInfo resource property to the template. + Adds an AWS::MSK::Cluster.EncryptionInfo resource property to the template. Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit. .DESCRIPTION Adds an AWS::MSK::Cluster.EncryptionInfo resource property to the template. - +Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptioninfo.html .PARAMETER EncryptionAtRest + The data-volume encryption details. + Type: EncryptionAtRest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptioninfo.html#cfn-msk-cluster-encryptioninfo-encryptionatrest UpdateType: Immutable .PARAMETER EncryptionInTransit + The details for encryption in transit. + Type: EncryptionInTransit Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptioninfo.html#cfn-msk-cluster-encryptioninfo-encryptionintransit UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterStorageInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterStorageInfo.ps1 index aadcb1f74..b2a12f3c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterStorageInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterStorageInfo.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterStorageInfo { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.StorageInfo resource property to the template. + Adds an AWS::MSK::Cluster.StorageInfo resource property to the template. Contains information about storage volumes attached to MSK broker nodes. .DESCRIPTION Adds an AWS::MSK::Cluster.StorageInfo resource property to the template. - +Contains information about storage volumes attached to MSK broker nodes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html .PARAMETER EBSStorageInfo + EBS volume information. + Type: EBSStorageInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html#cfn-msk-cluster-storageinfo-ebsstorageinfo UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterTls.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterTls.ps1 index 779ca6587..3a06574e0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterTls.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterTls.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterTls { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.Tls resource property to the template. + Adds an AWS::MSK::Cluster.Tls resource property to the template. Details for client authentication using TLS. .DESCRIPTION Adds an AWS::MSK::Cluster.Tls resource property to the template. - +Details for client authentication using TLS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html .PARAMETER CertificateAuthorityArnList + List of ACM Certificate Authority ARNs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html#cfn-msk-cluster-tls-certificateauthorityarnlist diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberApprovalThresholdPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberApprovalThresholdPolicy.ps1 index 30b7465c5..1562361dd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberApprovalThresholdPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberApprovalThresholdPolicy.ps1 @@ -1,26 +1,32 @@ function Add-VSManagedBlockchainMemberApprovalThresholdPolicy { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.ApprovalThresholdPolicy resource property to the template. + Adds an AWS::ManagedBlockchain::Member.ApprovalThresholdPolicy resource property to the template. A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.ApprovalThresholdPolicy resource property to the template. - +A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html .PARAMETER ThresholdComparator + Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html#cfn-managedblockchain-member-approvalthresholdpolicy-thresholdcomparator PrimitiveType: String UpdateType: Mutable .PARAMETER ThresholdPercentage + The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html#cfn-managedblockchain-member-approvalthresholdpolicy-thresholdpercentage PrimitiveType: Integer UpdateType: Mutable .PARAMETER ProposalDurationInHours + The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html#cfn-managedblockchain-member-approvalthresholdpolicy-proposaldurationinhours PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberConfiguration.ps1 index c2ff46a69..58474ffb8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSManagedBlockchainMemberMemberConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.MemberConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Member.MemberConfiguration resource property to the template. Configuration properties of the member. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.MemberConfiguration resource property to the template. - +Configuration properties of the member. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html .PARAMETER Description + An optional description of the member. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html#cfn-managedblockchain-member-memberconfiguration-description PrimitiveType: String UpdateType: Mutable .PARAMETER MemberFrameworkConfiguration + Configuration properties of the blockchain framework relevant to the member. + Type: MemberFrameworkConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html#cfn-managedblockchain-member-memberconfiguration-memberframeworkconfiguration UpdateType: Mutable .PARAMETER Name + The name of the member. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html#cfn-managedblockchain-member-memberconfiguration-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFabricConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFabricConfiguration.ps1 index 3b78c2372..a337c6a90 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFabricConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFabricConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSManagedBlockchainMemberMemberFabricConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.MemberFabricConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Member.MemberFabricConfiguration resource property to the template. Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.MemberFabricConfiguration resource property to the template. - +Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberfabricconfiguration.html .PARAMETER AdminUsername + The user name for the member's initial administrative user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberfabricconfiguration.html#cfn-managedblockchain-member-memberfabricconfiguration-adminusername PrimitiveType: String UpdateType: Mutable .PARAMETER AdminPassword + The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote‘, double quote“, forward slash/, backward slash, @, or a space. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberfabricconfiguration.html#cfn-managedblockchain-member-memberfabricconfiguration-adminpassword PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFrameworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFrameworkConfiguration.ps1 index 7752d4373..6df3ffed6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFrameworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberMemberFrameworkConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSManagedBlockchainMemberMemberFrameworkConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.MemberFrameworkConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Member.MemberFrameworkConfiguration resource property to the template. Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.MemberFrameworkConfiguration resource property to the template. - +Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberframeworkconfiguration.html .PARAMETER MemberFabricConfiguration + Configuration properties for Hyperledger Fabric. + Type: MemberFabricConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberframeworkconfiguration.html#cfn-managedblockchain-member-memberframeworkconfiguration-memberfabricconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkConfiguration.ps1 index 5fc750703..207df78ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkConfiguration.ps1 @@ -1,41 +1,53 @@ function Add-VSManagedBlockchainMemberNetworkConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.NetworkConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Member.NetworkConfiguration resource property to the template. Configuration properties of the network to which the member belongs. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.NetworkConfiguration resource property to the template. - +Configuration properties of the network to which the member belongs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html .PARAMETER Description + Attributes of the blockchain framework for the network. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-description PrimitiveType: String UpdateType: Mutable .PARAMETER FrameworkVersion + The version of the blockchain framework that the network uses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-frameworkversion PrimitiveType: String UpdateType: Mutable .PARAMETER VotingPolicy + The voting rules for the network to decide if a proposal is accepted. + Type: VotingPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-votingpolicy UpdateType: Mutable .PARAMETER Framework + The blockchain framework that the network uses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-framework PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the network. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-name PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkFrameworkConfiguration + Configuration properties relevant to the network for the blockchain framework that the network uses. + Type: NetworkFrameworkConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-networkframeworkconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFabricConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFabricConfiguration.ps1 index 4765bf6db..8abda940f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFabricConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFabricConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSManagedBlockchainMemberNetworkFabricConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.NetworkFabricConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Member.NetworkFabricConfiguration resource property to the template. Hyperledger Fabric configuration properties for the network. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.NetworkFabricConfiguration resource property to the template. - +Hyperledger Fabric configuration properties for the network. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkfabricconfiguration.html .PARAMETER Edition + The edition of Amazon Managed Blockchain that the network uses. Valid values are standard and starter. For more information, see + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkfabricconfiguration.html#cfn-managedblockchain-member-networkfabricconfiguration-edition PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFrameworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFrameworkConfiguration.ps1 index 4fcd52e7c..a762009b6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFrameworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberNetworkFrameworkConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSManagedBlockchainMemberNetworkFrameworkConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.NetworkFrameworkConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Member.NetworkFrameworkConfiguration resource property to the template. Configuration properties relevant to the network for the blockchain framework that the network uses. .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.NetworkFrameworkConfiguration resource property to the template. - +Configuration properties relevant to the network for the blockchain framework that the network uses. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkframeworkconfiguration.html .PARAMETER NetworkFabricConfiguration + Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework. + Type: NetworkFabricConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkframeworkconfiguration.html#cfn-managedblockchain-member-networkframeworkconfiguration-networkfabricconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberVotingPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberVotingPolicy.ps1 index 85c20874a..898e1747b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberVotingPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainMemberVotingPolicy.ps1 @@ -1,16 +1,18 @@ function Add-VSManagedBlockchainMemberVotingPolicy { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member.VotingPolicy resource property to the template. + Adds an AWS::ManagedBlockchain::Member.VotingPolicy resource property to the template. The voting rules for the network to decide if a proposal is accepted .DESCRIPTION Adds an AWS::ManagedBlockchain::Member.VotingPolicy resource property to the template. - +The voting rules for the network to decide if a proposal is accepted .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-votingpolicy.html .PARAMETER ApprovalThresholdPolicy + Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created. + Type: ApprovalThresholdPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-votingpolicy.html#cfn-managedblockchain-member-votingpolicy-approvalthresholdpolicy UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainNodeNodeConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainNodeNodeConfiguration.ps1 index fe62ad928..cbfb07e1a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainNodeNodeConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSManagedBlockchainNodeNodeConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSManagedBlockchainNodeNodeConfiguration { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Node.NodeConfiguration resource property to the template. + Adds an AWS::ManagedBlockchain::Node.NodeConfiguration resource property to the template. Configuration properties of a peer node within a membership. .DESCRIPTION Adds an AWS::ManagedBlockchain::Node.NodeConfiguration resource property to the template. - +Configuration properties of a peer node within a membership. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-node-nodeconfiguration.html .PARAMETER AvailabilityZone + The Availability Zone in which the node exists. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-node-nodeconfiguration.html#cfn-managedblockchain-node-nodeconfiguration-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The Amazon Managed Blockchain instance type for the node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-node-nodeconfiguration.html#cfn-managedblockchain-node-nodeconfiguration-instancetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAribSourceSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAribSourceSettings.ps1 index 8179fcd8e..b78c238b9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAribSourceSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAribSourceSettings.ps1 @@ -1,11 +1,13 @@ function Add-VSMediaLiveChannelAribSourceSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.AribSourceSettings resource property to the template. + Adds an AWS::MediaLive::Channel.AribSourceSettings resource property to the template. Information about the ARIB captions to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.AribSourceSettings resource property to the template. +Information about the ARIB captions to extract from the input. +The parent of this entity is CaptionSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aribsourcesettings.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioLanguageSelection.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioLanguageSelection.ps1 index cbd18b959..ff7a8562c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioLanguageSelection.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioLanguageSelection.ps1 @@ -1,21 +1,27 @@ function Add-VSMediaLiveChannelAudioLanguageSelection { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.AudioLanguageSelection resource property to the template. + Adds an AWS::MediaLive::Channel.AudioLanguageSelection resource property to the template. Information about the audio language to extract. .DESCRIPTION Adds an AWS::MediaLive::Channel.AudioLanguageSelection resource property to the template. +Information about the audio language to extract. +The parent of this entity is AudioSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiolanguageselection.html .PARAMETER LanguageCode + Selects a specific three-letter language code from within an audio source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiolanguageselection.html#cfn-medialive-channel-audiolanguageselection-languagecode PrimitiveType: String UpdateType: Mutable .PARAMETER LanguageSelectionPolicy + When set to "strict," the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present, then mute is encoded until the language returns. If set to "loose," then on a PMT update the demux chooses another audio stream in the program with the same stream type if it can't find one with the same language. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiolanguageselection.html#cfn-medialive-channel-audiolanguageselection-languageselectionpolicy PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioPidSelection.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioPidSelection.ps1 index 025c94d5b..350278cfc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioPidSelection.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioPidSelection.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelAudioPidSelection { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.AudioPidSelection resource property to the template. + Adds an AWS::MediaLive::Channel.AudioPidSelection resource property to the template. Used to extract audio by The PID. .DESCRIPTION Adds an AWS::MediaLive::Channel.AudioPidSelection resource property to the template. +Used to extract audio by The PID. +The parent of this entity is AudioSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiopidselection.html .PARAMETER Pid + Select the audio by this PID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiopidselection.html#cfn-medialive-channel-audiopidselection-pid PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelector.ps1 index 2d9f21ec9..d423b6c46 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelector.ps1 @@ -1,21 +1,25 @@ function Add-VSMediaLiveChannelAudioSelector { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.AudioSelector resource property to the template. + Adds an AWS::MediaLive::Channel.AudioSelector resource property to the template. Information about one audio to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.AudioSelector resource property to the template. - +Information about one audio to extract from the input. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselector.html .PARAMETER SelectorSettings + Information about the specific audio to extract from the input. + Type: AudioSelectorSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselector.html#cfn-medialive-channel-audioselector-selectorsettings UpdateType: Mutable .PARAMETER Name + A name for this AudioSelector. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselector.html#cfn-medialive-channel-audioselector-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelectorSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelectorSettings.ps1 index 039f74450..86f245f2f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelectorSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelAudioSelectorSettings.ps1 @@ -1,21 +1,27 @@ function Add-VSMediaLiveChannelAudioSelectorSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.AudioSelectorSettings resource property to the template. + Adds an AWS::MediaLive::Channel.AudioSelectorSettings resource property to the template. Information about the audio to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.AudioSelectorSettings resource property to the template. +Information about the audio to extract from the input. +The parent of this entity is AudioSelector. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html .PARAMETER AudioPidSelection + The PID of the audio to select. + Type: AudioPidSelection Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html#cfn-medialive-channel-audioselectorsettings-audiopidselection UpdateType: Mutable .PARAMETER AudioLanguageSelection + The language code of the audio to select. + Type: AudioLanguageSelection Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html#cfn-medialive-channel-audioselectorsettings-audiolanguageselection UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelector.ps1 index f4b6edbb3..c8cfcce41 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelector.ps1 @@ -1,26 +1,34 @@ function Add-VSMediaLiveChannelCaptionSelector { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.CaptionSelector resource property to the template. + Adds an AWS::MediaLive::Channel.CaptionSelector resource property to the template. Information about one caption to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.CaptionSelector resource property to the template. +Information about one caption to extract from the input. +The parent of this entity is InputSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html .PARAMETER LanguageCode + When specified, this field indicates the three-letter language code of the captions track to extract from the source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html#cfn-medialive-channel-captionselector-languagecode PrimitiveType: String UpdateType: Mutable .PARAMETER SelectorSettings + Information about the specific audio to extract from the input. + Type: CaptionSelectorSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html#cfn-medialive-channel-captionselector-selectorsettings UpdateType: Mutable .PARAMETER Name + The name identifier for a captions selector. This name is used to associate this captions selector with one or more captions descriptions. Names must be unique within a channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html#cfn-medialive-channel-captionselector-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelectorSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelectorSettings.ps1 index dd4f6af4e..76591e979 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelectorSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelCaptionSelectorSettings.ps1 @@ -1,41 +1,55 @@ function Add-VSMediaLiveChannelCaptionSelectorSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.CaptionSelectorSettings resource property to the template. + Adds an AWS::MediaLive::Channel.CaptionSelectorSettings resource property to the template. Captions Selector Settings .DESCRIPTION Adds an AWS::MediaLive::Channel.CaptionSelectorSettings resource property to the template. +Captions Selector Settings +The parent of this entity is CaptionSelector. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html .PARAMETER DvbSubSourceSettings + Information about the DVB Sub captions to extract from the input. + Type: DvbSubSourceSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-dvbsubsourcesettings UpdateType: Mutable .PARAMETER Scte27SourceSettings + Information about the SCTE-27 captions to extract from the input. + Type: Scte27SourceSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-scte27sourcesettings UpdateType: Mutable .PARAMETER AribSourceSettings + Information about the ARIB captions to extract from the input. + Type: AribSourceSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-aribsourcesettings UpdateType: Mutable .PARAMETER EmbeddedSourceSettings + Information about the embedded captions to extract from the input. + Type: EmbeddedSourceSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-embeddedsourcesettings UpdateType: Mutable .PARAMETER Scte20SourceSettings + Information about the SCTE-20 captions to extract from the input. + Type: Scte20SourceSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-scte20sourcesettings UpdateType: Mutable .PARAMETER TeletextSourceSettings + Information about the Teletext captions to extract from the input. + Type: TeletextSourceSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-teletextsourcesettings UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelDvbSubSourceSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelDvbSubSourceSettings.ps1 index 9881a2a8d..aa0c5c10a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelDvbSubSourceSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelDvbSubSourceSettings.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelDvbSubSourceSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.DvbSubSourceSettings resource property to the template. + Adds an AWS::MediaLive::Channel.DvbSubSourceSettings resource property to the template. Information about the DVB Sub captions to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.DvbSubSourceSettings resource property to the template. +Information about the DVB Sub captions to extract from the input. +The parent of this entity is CaptionSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubsourcesettings.html .PARAMETER Pid + When using DVB-Sub with burn-in or SMPTE-TT, use this PID for the source content. It is unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubsourcesettings.html#cfn-medialive-channel-dvbsubsourcesettings-pid PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelEmbeddedSourceSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelEmbeddedSourceSettings.ps1 index 2ba3f5824..3b45c300d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelEmbeddedSourceSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelEmbeddedSourceSettings.ps1 @@ -1,31 +1,41 @@ function Add-VSMediaLiveChannelEmbeddedSourceSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.EmbeddedSourceSettings resource property to the template. + Adds an AWS::MediaLive::Channel.EmbeddedSourceSettings resource property to the template. Information about the embedded captions to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.EmbeddedSourceSettings resource property to the template. +Information about the embedded captions to extract from the input. +The parent of this entity is CaptionSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html .PARAMETER Source608ChannelNumber + Specifies the 608/708 channel number within the video track from which to extract captions. This is unused for passthrough. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-source608channelnumber PrimitiveType: Integer UpdateType: Mutable .PARAMETER Scte20Detection + Set to "auto" to handle streams with intermittent or non-aligned SCTE-20 and embedded captions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-scte20detection PrimitiveType: String UpdateType: Mutable .PARAMETER Source608TrackNumber + This field is unused and deprecated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-source608tracknumber PrimitiveType: Integer UpdateType: Mutable .PARAMETER Convert608To708 + If this is upconvert, 608 data is both passed through the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. If 708 data is present in the source content, it is discarded. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-convert608to708 PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelHlsInputSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelHlsInputSettings.ps1 index 71a794991..c831d77f9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelHlsInputSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelHlsInputSettings.ps1 @@ -1,31 +1,41 @@ function Add-VSMediaLiveChannelHlsInputSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.HlsInputSettings resource property to the template. + Adds an AWS::MediaLive::Channel.HlsInputSettings resource property to the template. Information about how to connect to the upstream system. .DESCRIPTION Adds an AWS::MediaLive::Channel.HlsInputSettings resource property to the template. +Information about how to connect to the upstream system. +The parent of this entity is NetworkInputSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html .PARAMETER BufferSegments + When specified, reading of the HLS input begins this many buffer segments from the end most recently written segment. When not specified, the HLS input begins with the first segment specified in the m3u8. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-buffersegments PrimitiveType: Integer UpdateType: Mutable .PARAMETER Retries + The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-retries PrimitiveType: Integer UpdateType: Mutable .PARAMETER Bandwidth + When specified, the HLS stream with the m3u8 BANDWIDTH that most closely matches this value is chosen. Otherwise, the highest bandwidth stream in the m3u8 is chosen. The bitrate is specified in bits per second, as in an HLS manifest. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-bandwidth PrimitiveType: Integer UpdateType: Mutable .PARAMETER RetryInterval + The number of seconds between retries when an attempt to read a manifest or segment fails. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-retryinterval PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputAttachment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputAttachment.ps1 index 8a641df37..d330d01d9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputAttachment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputAttachment.ps1 @@ -1,26 +1,34 @@ function Add-VSMediaLiveChannelInputAttachment { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.InputAttachment resource property to the template. + Adds an AWS::MediaLive::Channel.InputAttachment resource property to the template. An input to attach to this channel. .DESCRIPTION Adds an AWS::MediaLive::Channel.InputAttachment resource property to the template. +An input to attach to this channel. +This entity is at the top level in the channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html .PARAMETER InputAttachmentName + A name for the attachment. This is required if you want to use this input in an input switch action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputattachmentname PrimitiveType: String UpdateType: Mutable .PARAMETER InputId + The ID of the input to attach. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputid PrimitiveType: String UpdateType: Immutable .PARAMETER InputSettings + Information about the content to extract from the input and about the general handling of the content. + Type: InputSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputsettings UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSettings.ps1 index e8c836a22..0ff4e00f6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSettings.ps1 @@ -1,58 +1,78 @@ function Add-VSMediaLiveChannelInputSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.InputSettings resource property to the template. + Adds an AWS::MediaLive::Channel.InputSettings resource property to the template. Information about extracting content from the input and about handling the content. .DESCRIPTION Adds an AWS::MediaLive::Channel.InputSettings resource property to the template. +Information about extracting content from the input and about handling the content. +The parent of this entity is InputAttachment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html .PARAMETER DeblockFilter + Enables or disables the deblock filter when filtering. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-deblockfilter PrimitiveType: String UpdateType: Mutable .PARAMETER FilterStrength + Adjusts the magnitude of filtering from 1 minimal to 5 strongest. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-filterstrength PrimitiveType: Integer UpdateType: Mutable .PARAMETER InputFilter + Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1 auto - filtering is applied depending on input type/quality 2 disabled - no filtering is applied to the input 3 forced - filtering is applied regardless of the input type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-inputfilter PrimitiveType: String UpdateType: Mutable .PARAMETER SourceEndBehavior + The loop input if it is a file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-sourceendbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER VideoSelector + Information about one video to extract from the input. + Type: VideoSelector Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-videoselector UpdateType: Mutable .PARAMETER AudioSelectors + Information about the specific audio to extract from the input. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-audioselectors ItemType: AudioSelector UpdateType: Mutable .PARAMETER CaptionSelectors + Information about the specific captions to extract from the input. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-captionselectors ItemType: CaptionSelector UpdateType: Mutable .PARAMETER DenoiseFilter + Enables or disables the denoise filter when filtering. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-denoisefilter PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkInputSettings + Information about how to connect to the upstream system. + Type: NetworkInputSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-networkinputsettings UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSpecification.ps1 index fce84817d..c8e66627a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelInputSpecification.ps1 @@ -1,26 +1,34 @@ function Add-VSMediaLiveChannelInputSpecification { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.InputSpecification resource property to the template. + Adds an AWS::MediaLive::Channel.InputSpecification resource property to the template. The input specification for this channel. It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec. .DESCRIPTION Adds an AWS::MediaLive::Channel.InputSpecification resource property to the template. +The input specification for this channel. It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec. +This entity is at the top level in the channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html .PARAMETER Codec + The codec to include in the input specification for this channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html#cfn-medialive-channel-inputspecification-codec PrimitiveType: String UpdateType: Mutable .PARAMETER MaximumBitrate + The maximum input bitrate for any input attached to this channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html#cfn-medialive-channel-inputspecification-maximumbitrate PrimitiveType: String UpdateType: Mutable .PARAMETER Resolution + The resolution for any input attached to this channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html#cfn-medialive-channel-inputspecification-resolution PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMediaPackageOutputDestinationSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMediaPackageOutputDestinationSettings.ps1 index 48892fc6b..6e8aefbaf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMediaPackageOutputDestinationSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMediaPackageOutputDestinationSettings.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelMediaPackageOutputDestinationSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings resource property to the template. + Adds an AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings resource property to the template. Destination settings for a MediaPackage output. .DESCRIPTION Adds an AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings resource property to the template. +Destination settings for a MediaPackage output. +The parent of this entity is OutputDestination. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html .PARAMETER ChannelId + The ID of the channel in MediaPackage that is the destination for this output group. You don't need to specify the individual inputs in MediaPackage; MediaLive handles the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html#cfn-medialive-channel-mediapackageoutputdestinationsettings-channelid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelNetworkInputSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelNetworkInputSettings.ps1 index 5deea0dc2..644d80906 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelNetworkInputSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelNetworkInputSettings.ps1 @@ -1,21 +1,27 @@ function Add-VSMediaLiveChannelNetworkInputSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.NetworkInputSettings resource property to the template. + Adds an AWS::MediaLive::Channel.NetworkInputSettings resource property to the template. Information about how to connect to the upstream system. .DESCRIPTION Adds an AWS::MediaLive::Channel.NetworkInputSettings resource property to the template. +Information about how to connect to the upstream system. +The parent of this entity is InputSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html .PARAMETER ServerValidation + Checks HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate is checked, but not the server's name. Certain subdomains notably S3 buckets that use dots in the bucket name don't strictly match the corresponding certificate's wildcard pattern and would otherwise cause the channel to error. This setting is ignored for protocols that do not use HTTPS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html#cfn-medialive-channel-networkinputsettings-servervalidation PrimitiveType: String UpdateType: Mutable .PARAMETER HlsInputSettings + Information about how to connect to the upstream system. + Type: HlsInputSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html#cfn-medialive-channel-networkinputsettings-hlsinputsettings UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 index 1af31ef60..7a72f0b83 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 @@ -1,32 +1,42 @@ function Add-VSMediaLiveChannelOutputDestination { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.OutputDestination resource property to the template. + Adds an AWS::MediaLive::Channel.OutputDestination resource property to the template. Configuration information for an output. .DESCRIPTION Adds an AWS::MediaLive::Channel.OutputDestination resource property to the template. +Configuration information for an output. +This entity is at the top level in the channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html .PARAMETER MultiplexSettings + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Type: MultiplexProgramChannelDestinationSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-multiplexsettings UpdateType: Mutable .PARAMETER Id + The ID for this destination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-id PrimitiveType: String UpdateType: Mutable .PARAMETER Settings + The destination settings for an output. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-settings ItemType: OutputDestinationSettings UpdateType: Mutable .PARAMETER MediaPackageSettings + The destination settings for a MediaPackage output. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-mediapackagesettings ItemType: MediaPackageOutputDestinationSettings diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestinationSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestinationSettings.ps1 index a003616b5..fd9c22575 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestinationSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestinationSettings.ps1 @@ -1,31 +1,42 @@ function Add-VSMediaLiveChannelOutputDestinationSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.OutputDestinationSettings resource property to the template. + Adds an AWS::MediaLive::Channel.OutputDestinationSettings resource property to the template. The configuration information for this output. .DESCRIPTION Adds an AWS::MediaLive::Channel.OutputDestinationSettings resource property to the template. +The configuration information for this output. +The parent of this entity is OutputDestination. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html .PARAMETER StreamName + The stream name for the content. This applies only to RTMP outputs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-streamname PrimitiveType: String UpdateType: Mutable .PARAMETER Username + The user name for the downstream system. This applies only if the downstream system requires credentials. +user name for destination + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-username PrimitiveType: String UpdateType: Mutable .PARAMETER PasswordParam + The password parameter that holds the password for accessing the downstream system. This password parameter applies only if the downstream system requires credentials. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-passwordparam PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The URL for the destination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte20SourceSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte20SourceSettings.ps1 index b57a5f14e..0c3c62798 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte20SourceSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte20SourceSettings.ps1 @@ -1,21 +1,27 @@ function Add-VSMediaLiveChannelScte20SourceSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.Scte20SourceSettings resource property to the template. + Adds an AWS::MediaLive::Channel.Scte20SourceSettings resource property to the template. Information about the SCTE-20 captions to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.Scte20SourceSettings resource property to the template. +Information about the SCTE-20 captions to extract from the input. +The parent of this entity is CaptionSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html .PARAMETER Source608ChannelNumber + Specifies the 608/708 channel number within the video track from which to extract captions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html#cfn-medialive-channel-scte20sourcesettings-source608channelnumber PrimitiveType: Integer UpdateType: Mutable .PARAMETER Convert608To708 + If upconvert, 608 data is both passed through the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. Any 708 data present in the source content is discarded. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html#cfn-medialive-channel-scte20sourcesettings-convert608to708 PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte27SourceSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte27SourceSettings.ps1 index 0d959abc1..f1fff573c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte27SourceSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelScte27SourceSettings.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelScte27SourceSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.Scte27SourceSettings resource property to the template. + Adds an AWS::MediaLive::Channel.Scte27SourceSettings resource property to the template. Information about the SCTE-27 captions to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.Scte27SourceSettings resource property to the template. +Information about the SCTE-27 captions to extract from the input. +The parent of this entity is CaptionSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html .PARAMETER Pid + The PID field is used in conjunction with the captions selector languageCode field as follows: Specify PID and Language: Extracts captions from that PID; the language is "informational." Specify PID and omit Language: Extracts the specified PID. Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages are passed through. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-pid PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelTeletextSourceSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelTeletextSourceSettings.ps1 index c9f6d6553..9cad637b7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelTeletextSourceSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelTeletextSourceSettings.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelTeletextSourceSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.TeletextSourceSettings resource property to the template. + Adds an AWS::MediaLive::Channel.TeletextSourceSettings resource property to the template. Information about the Teletext captions to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.TeletextSourceSettings resource property to the template. +Information about the Teletext captions to extract from the input. +The parent of this entity is CaptionSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html .PARAMETER PageNumber + Specifies the Teletext page number within the data stream from which to extract captions. The range is 0x100 256 to 0x8FF 2303. This is unused for passthrough. It should be specified as a hexadecimal string with no "0x" prefix. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html#cfn-medialive-channel-teletextsourcesettings-pagenumber PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelector.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelector.ps1 index 174179e7f..129930d67 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelector.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelector.ps1 @@ -1,26 +1,34 @@ function Add-VSMediaLiveChannelVideoSelector { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.VideoSelector resource property to the template. + Adds an AWS::MediaLive::Channel.VideoSelector resource property to the template. Information about the video to extract from the input. An input can contain only one video selector. .DESCRIPTION Adds an AWS::MediaLive::Channel.VideoSelector resource property to the template. +Information about the video to extract from the input. An input can contain only one video selector. +The parent of this entity is InputSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html .PARAMETER SelectorSettings + Information about the video to select from the content. + Type: VideoSelectorSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-selectorsettings UpdateType: Mutable .PARAMETER ColorSpace + Specifies the color space of an input. This setting works in tandem with colorSpaceConversion to determine if MediaLive will perform any conversion. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspace PrimitiveType: String UpdateType: Mutable .PARAMETER ColorSpaceUsage + Applies only if colorSpace is a value other than Follow. This field controls how the value in the colorSpace field is used. Fallback means that when the input does include color space data, that data is used, but when the input has no color space data, the value in colorSpace is used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. Force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspaceusage PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorPid.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorPid.ps1 index f6e4306df..2d9edee1d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorPid.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorPid.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelVideoSelectorPid { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.VideoSelectorPid resource property to the template. + Adds an AWS::MediaLive::Channel.VideoSelectorPid resource property to the template. Selects a specific PID from within a video source. .DESCRIPTION Adds an AWS::MediaLive::Channel.VideoSelectorPid resource property to the template. +Selects a specific PID from within a video source. +The parent of this entity is VideoSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.html .PARAMETER Pid + Selects a specific PID from within a video source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.html#cfn-medialive-channel-videoselectorpid-pid PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorProgramId.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorProgramId.ps1 index 5b20ca2ad..ee7cd2311 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorProgramId.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorProgramId.ps1 @@ -1,16 +1,20 @@ function Add-VSMediaLiveChannelVideoSelectorProgramId { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.VideoSelectorProgramId resource property to the template. + Adds an AWS::MediaLive::Channel.VideoSelectorProgramId resource property to the template. Used to extract video by the program ID. .DESCRIPTION Adds an AWS::MediaLive::Channel.VideoSelectorProgramId resource property to the template. +Used to extract video by the program ID. +The parent of this entity is VideoSelectorSettings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorprogramid.html .PARAMETER ProgramId + Selects a specific program from within a multi-program transport stream. If the program doesn't exist, MediaLive selects the first program within the transport stream by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorprogramid.html#cfn-medialive-channel-videoselectorprogramid-programid PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorSettings.ps1 index 9ab23e5f3..85ec448f4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelVideoSelectorSettings.ps1 @@ -1,21 +1,27 @@ function Add-VSMediaLiveChannelVideoSelectorSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.VideoSelectorSettings resource property to the template. + Adds an AWS::MediaLive::Channel.VideoSelectorSettings resource property to the template. Information about the video to extract from the input. .DESCRIPTION Adds an AWS::MediaLive::Channel.VideoSelectorSettings resource property to the template. +Information about the video to extract from the input. +The parent of this entity is VideoSelector. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html .PARAMETER VideoSelectorProgramId + Used to extract video by program ID. + Type: VideoSelectorProgramId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html#cfn-medialive-channel-videoselectorsettings-videoselectorprogramid UpdateType: Mutable .PARAMETER VideoSelectorPid + Used to extract video by PID. + Type: VideoSelectorPid Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html#cfn-medialive-channel-videoselectorsettings-videoselectorpid UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputDestinationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputDestinationRequest.ps1 index c3c11f693..4ed966fb9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputDestinationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputDestinationRequest.ps1 @@ -1,16 +1,18 @@ function Add-VSMediaLiveInputInputDestinationRequest { <# .SYNOPSIS - Adds an AWS::MediaLive::Input.InputDestinationRequest resource property to the template. + Adds an AWS::MediaLive::Input.InputDestinationRequest resource property to the template. The settings for a push input, to set up the destination addresses on MediaLive. .DESCRIPTION Adds an AWS::MediaLive::Input.InputDestinationRequest resource property to the template. - +The settings for a push input, to set up the destination addresses on MediaLive. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputdestinationrequest.html .PARAMETER StreamName + The stream name application name/application instance for the location the RTMP source content will be pushed to in MediaLive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputdestinationrequest.html#cfn-medialive-input-inputdestinationrequest-streamname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputSourceRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputSourceRequest.ps1 index 9a9e18610..5520f2aeb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputSourceRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputSourceRequest.ps1 @@ -1,26 +1,32 @@ function Add-VSMediaLiveInputInputSourceRequest { <# .SYNOPSIS - Adds an AWS::MediaLive::Input.InputSourceRequest resource property to the template. + Adds an AWS::MediaLive::Input.InputSourceRequest resource property to the template. The settings for a pull input. .DESCRIPTION Adds an AWS::MediaLive::Input.InputSourceRequest resource property to the template. - +The settings for a pull input. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputsourcerequest.html .PARAMETER Username + The user name for accessing the upstream system. The user name applies only if the upstream system requires credentials. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputsourcerequest.html#cfn-medialive-input-inputsourcerequest-username PrimitiveType: String UpdateType: Mutable .PARAMETER PasswordParam + The password parameter that holds the password for accessing the upstream system. The password parameter applies only if the upstream system requires credentials. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputsourcerequest.html#cfn-medialive-input-inputsourcerequest-passwordparam PrimitiveType: String UpdateType: Mutable .PARAMETER Url + For a pull input, the URL where MediaLive pulls the source content from. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputsourcerequest.html#cfn-medialive-input-inputsourcerequest-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputVpcRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputVpcRequest.ps1 index a8c08c199..847488f1e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputVpcRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputInputVpcRequest.ps1 @@ -1,22 +1,26 @@ function Add-VSMediaLiveInputInputVpcRequest { <# .SYNOPSIS - Adds an AWS::MediaLive::Input.InputVpcRequest resource property to the template. + Adds an AWS::MediaLive::Input.InputVpcRequest resource property to the template. The settings for an Amazon VPC input. .DESCRIPTION Adds an AWS::MediaLive::Input.InputVpcRequest resource property to the template. - +The settings for an Amazon VPC input. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputvpcrequest.html .PARAMETER SecurityGroupIds + The list of up to five VPC security group IDs to attach to the input VPC network interfaces. The security groups require subnet IDs. If none are specified, MediaLive uses the VPC default security group. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputvpcrequest.html#cfn-medialive-input-inputvpcrequest-securitygroupids UpdateType: Mutable .PARAMETER SubnetIds + The list of two VPC subnet IDs from the same VPC. You must associate subnet IDs to two unique Availability Zones. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-inputvpcrequest.html#cfn-medialive-input-inputvpcrequest-subnetids diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputMediaConnectFlowRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputMediaConnectFlowRequest.ps1 index 7284bb85f..9e496049b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputMediaConnectFlowRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputMediaConnectFlowRequest.ps1 @@ -1,16 +1,18 @@ function Add-VSMediaLiveInputMediaConnectFlowRequest { <# .SYNOPSIS - Adds an AWS::MediaLive::Input.MediaConnectFlowRequest resource property to the template. + Adds an AWS::MediaLive::Input.MediaConnectFlowRequest resource property to the template. The settings for a MediaConnect Flow. .DESCRIPTION Adds an AWS::MediaLive::Input.MediaConnectFlowRequest resource property to the template. - +The settings for a MediaConnect Flow. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-mediaconnectflowrequest.html .PARAMETER FlowArn + The ARN of one or two MediaConnect flows that are the sources for this MediaConnect input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-input-mediaconnectflowrequest.html#cfn-medialive-input-mediaconnectflowrequest-flowarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputSecurityGroupInputWhitelistRuleCidr.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputSecurityGroupInputWhitelistRuleCidr.ps1 index a9cb033f2..e2071542b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputSecurityGroupInputWhitelistRuleCidr.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveInputSecurityGroupInputWhitelistRuleCidr.ps1 @@ -1,16 +1,18 @@ function Add-VSMediaLiveInputSecurityGroupInputWhitelistRuleCidr { <# .SYNOPSIS - Adds an AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr resource property to the template. + Adds an AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr resource property to the template. An IPv4 CIDR range to include in this input security group. .DESCRIPTION Adds an AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr resource property to the template. - +An IPv4 CIDR range to include in this input security group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-inputsecuritygroup-inputwhitelistrulecidr.html .PARAMETER Cidr + An IPv4 CIDR range to include in this input security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-inputsecuritygroup-inputwhitelistrulecidr.html#cfn-medialive-inputsecuritygroup-inputwhitelistrulecidr-cidr PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaStoreContainerCorsRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaStoreContainerCorsRule.ps1 index 3fd35303c..564ab21f6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaStoreContainerCorsRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaStoreContainerCorsRule.ps1 @@ -1,39 +1,54 @@ function Add-VSMediaStoreContainerCorsRule { <# .SYNOPSIS - Adds an AWS::MediaStore::Container.CorsRule resource property to the template. + Adds an AWS::MediaStore::Container.CorsRule resource property to the template. A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. .DESCRIPTION Adds an AWS::MediaStore::Container.CorsRule resource property to the template. - +A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html .PARAMETER AllowedMethods + Identifies an HTTP method that the origin that is specified in the rule is allowed to execute. +Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html#cfn-mediastore-container-corsrule-allowedmethods UpdateType: Immutable .PARAMETER AllowedOrigins + One or more response headers that you want users to be able to access from their applications for example, from a JavaScript XMLHttpRequest object. +Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character *, for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html#cfn-mediastore-container-corsrule-allowedorigins UpdateType: Mutable .PARAMETER ExposeHeaders + One or more headers in the response that you want users to be able to access from their applications for example, from a JavaScript XMLHttpRequest object. +This element is optional for each rule. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html#cfn-mediastore-container-corsrule-exposeheaders UpdateType: Mutable .PARAMETER MaxAgeSeconds + The time in seconds that your browser caches the preflight response for the specified resource. +A CORS rule can have only one MaxAgeSeconds element. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html#cfn-mediastore-container-corsrule-maxageseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER AllowedHeaders + Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back. +This element can contain only one wildcard character *. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html#cfn-mediastore-container-corsrule-allowedheaders diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppDataSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppDataSource.ps1 index 42cb52b91..a18ce0498 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppDataSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppDataSource.ps1 @@ -1,26 +1,32 @@ function Add-VSOpsWorksAppDataSource { <# .SYNOPSIS - Adds an AWS::OpsWorks::App.DataSource resource property to the template. + Adds an AWS::OpsWorks::App.DataSource resource property to the template. Describes an app's data source. .DESCRIPTION Adds an AWS::OpsWorks::App.DataSource resource property to the template. - +Describes an app's data source. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html .PARAMETER Arn + The data source's ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName + The database name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppEnvironmentVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppEnvironmentVariable.ps1 index ce689c633..05ee2affd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppEnvironmentVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppEnvironmentVariable.ps1 @@ -1,26 +1,32 @@ function Add-VSOpsWorksAppEnvironmentVariable { <# .SYNOPSIS - Adds an AWS::OpsWorks::App.EnvironmentVariable resource property to the template. + Adds an AWS::OpsWorks::App.EnvironmentVariable resource property to the template. Represents an app's environment variable. .DESCRIPTION Adds an AWS::OpsWorks::App.EnvironmentVariable resource property to the template. - +Represents an app's environment variable. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html .PARAMETER Key + Required The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores _, but it must start with a letter or underscore. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-key PrimitiveType: String UpdateType: Mutable .PARAMETER Secure + Optional Whether the variable's value will be returned by the DescribeApps: https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-secure PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Value + Optional The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSource.ps1 index f1e1512ac..5af9522aa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSource.ps1 @@ -1,41 +1,60 @@ function Add-VSOpsWorksAppSource { <# .SYNOPSIS - Adds an AWS::OpsWorks::App.Source resource property to the template. + Adds an AWS::OpsWorks::App.Source resource property to the template. Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html or Custom Recipes and Cookbooks: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html. .DESCRIPTION Adds an AWS::OpsWorks::App.Source resource property to the template. - +Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html or Custom Recipes and Cookbooks: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html .PARAMETER Password + When included in a request, the parameter depends on the repository type. ++ For Amazon S3 bundles, set Password to the appropriate IAM secret access key. ++ For HTTP bundles and Subversion repositories, set Password to the password. +For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html: https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html. +In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-pw PrimitiveType: String UpdateType: Mutable .PARAMETER Revision + The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision PrimitiveType: String UpdateType: Mutable .PARAMETER SshKey + The repository's SSH key. For more information, see Using Git Repository SSH Keys: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html in the *AWS OpsWorks User Guide*. To pass in an SSH key as a parameter, see the following example: +"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : "n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ... + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The repository type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url PrimitiveType: String UpdateType: Mutable .PARAMETER Username + This parameter depends on the repository type. ++ For Amazon S3 bundles, set Username to the appropriate IAM access key ID. ++ For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSslConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSslConfiguration.ps1 index 310774bf2..a6cc423e1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSslConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksAppSslConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSOpsWorksAppSslConfiguration { <# .SYNOPSIS - Adds an AWS::OpsWorks::App.SslConfiguration resource property to the template. + Adds an AWS::OpsWorks::App.SslConfiguration resource property to the template. Describes an app's SSL configuration. .DESCRIPTION Adds an AWS::OpsWorks::App.SslConfiguration resource property to the template. - +Describes an app's SSL configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html .PARAMETER Certificate + The contents of the certificate's domain.crt file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER Chain + Optional. Can be used to specify an intermediate certificate authority key or client authentication. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-chain PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateKey + The private key; the contents of the certificate's domain.kex file. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-privatekey PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksCMServerEngineAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksCMServerEngineAttribute.ps1 index f0e8c00eb..f04cdc233 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksCMServerEngineAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksCMServerEngineAttribute.ps1 @@ -1,21 +1,39 @@ function Add-VSOpsWorksCMServerEngineAttribute { <# .SYNOPSIS - Adds an AWS::OpsWorksCM::Server.EngineAttribute resource property to the template. + Adds an AWS::OpsWorksCM::Server.EngineAttribute resource property to the template. The EngineAttribute property type specifies administrator credentials for an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server. EngineAttribute is a property of the AWS::OpsWorksCM::Server resource type. .DESCRIPTION Adds an AWS::OpsWorksCM::Server.EngineAttribute resource property to the template. - +The EngineAttribute property type specifies administrator credentials for an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server. EngineAttribute is a property of the AWS::OpsWorksCM::Server resource type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html .PARAMETER Value + The value of the engine attribute. +**Attribute value for Chef Automate servers:** ++ CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL: https://www.openssl.org/ command on Linux-based computers. +openssl genrsa -out pivotal_key_file_name.pem 2048 +On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows: https://www.ssh.com/ssh/putty/windows/puttygen on SSH.com. +**Attribute values for Puppet Enterprise servers:** ++ PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters. ++ PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository for example, ssh://git@your.git-repo.com:user/control-repo.git. Specifying an r10k remote opens TCP port 8170. ++ PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html#cfn-opsworkscm-server-engineattribute-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the engine attribute. +**Attribute name for Chef Automate servers:** ++ CHEF_AUTOMATE_ADMIN_PASSWORD +**Attribute names for Puppet Enterprise servers:** ++ PUPPET_ADMIN_PASSWORD ++ PUPPET_R10K_REMOTE ++ PUPPET_R10K_PRIVATE_KEY + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html#cfn-opsworkscm-server-engineattribute-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceBlockDeviceMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceBlockDeviceMapping.ps1 index a1a1aca2d..911114c25 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceBlockDeviceMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceBlockDeviceMapping.ps1 @@ -1,31 +1,39 @@ function Add-VSOpsWorksInstanceBlockDeviceMapping { <# .SYNOPSIS - Adds an AWS::OpsWorks::Instance.BlockDeviceMapping resource property to the template. + Adds an AWS::OpsWorks::Instance.BlockDeviceMapping resource property to the template. Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html data type. .DESCRIPTION Adds an AWS::OpsWorks::Instance.BlockDeviceMapping resource property to the template. - +Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html data type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html .PARAMETER DeviceName + The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename PrimitiveType: String UpdateType: Mutable .PARAMETER Ebs + An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched. You can specify either the VirtualName or Ebs, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs Type: EbsBlockDevice UpdateType: Mutable .PARAMETER NoDevice + Suppresses the specified device included in the AMI's block device mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice PrimitiveType: String UpdateType: Mutable .PARAMETER VirtualName + The virtual device name. For more information, see BlockDeviceMapping: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html. You can specify either the VirtualName or Ebs, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceEbsBlockDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceEbsBlockDevice.ps1 index 347f6d5ff..1ade6c756 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceEbsBlockDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceEbsBlockDevice.ps1 @@ -1,36 +1,47 @@ function Add-VSOpsWorksInstanceEbsBlockDevice { <# .SYNOPSIS - Adds an AWS::OpsWorks::Instance.EbsBlockDevice resource property to the template. + Adds an AWS::OpsWorks::Instance.EbsBlockDevice resource property to the template. Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html data type. .DESCRIPTION Adds an AWS::OpsWorks::Instance.EbsBlockDevice resource property to the template. - +Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html data type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html .PARAMETER DeleteOnTermination + Whether the volume is deleted on instance termination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS that the volume supports. For more information, see EbsBlockDevice: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotId + The snapshot ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid PrimitiveType: String UpdateType: Mutable .PARAMETER VolumeSize + The volume size, in GiB. For more information, see EbsBlockDevice: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type. gp2 for General Purpose SSD volumes, io1 for Provisioned IOPS SSD volumes, st1 for Throughput Optimized hard disk drives HDD, sc1 for Cold HDD,and standard for Magnetic volumes. +If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size in GiB is 50:1. AWS uses the default volume size in GiB specified in the AMI attributes to set IOPS to 50 x volume size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceTimeBasedAutoScaling.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceTimeBasedAutoScaling.ps1 index a350a59be..f5f105a9f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceTimeBasedAutoScaling.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksInstanceTimeBasedAutoScaling.ps1 @@ -1,16 +1,18 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { <# .SYNOPSIS - Adds an AWS::OpsWorks::Instance.TimeBasedAutoScaling resource property to the template. + Adds an AWS::OpsWorks::Instance.TimeBasedAutoScaling resource property to the template. Describes an instance's time-based auto scaling configuration. .DESCRIPTION Adds an AWS::OpsWorks::Instance.TimeBasedAutoScaling resource property to the template. - +Describes an instance's time-based auto scaling configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html .PARAMETER Friday + The schedule for Friday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-friday DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { UpdateType: Mutable .PARAMETER Monday + The schedule for Monday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-monday DuplicatesAllowed: False PrimitiveItemType: String @@ -25,6 +29,8 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { UpdateType: Mutable .PARAMETER Saturday + The schedule for Saturday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-saturday DuplicatesAllowed: False PrimitiveItemType: String @@ -32,6 +38,8 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { UpdateType: Mutable .PARAMETER Sunday + The schedule for Sunday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-sunday DuplicatesAllowed: False PrimitiveItemType: String @@ -39,6 +47,8 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { UpdateType: Mutable .PARAMETER Thursday + The schedule for Thursday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-thursday DuplicatesAllowed: False PrimitiveItemType: String @@ -46,6 +56,8 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { UpdateType: Mutable .PARAMETER Tuesday + The schedule for Tuesday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-tuesday DuplicatesAllowed: False PrimitiveItemType: String @@ -53,6 +65,8 @@ function Add-VSOpsWorksInstanceTimeBasedAutoScaling { UpdateType: Mutable .PARAMETER Wednesday + The schedule for Wednesday. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-wednesday DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerAutoScalingThresholds.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerAutoScalingThresholds.ps1 index 8c62788c3..024597d7f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerAutoScalingThresholds.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerAutoScalingThresholds.ps1 @@ -1,41 +1,53 @@ function Add-VSOpsWorksLayerAutoScalingThresholds { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer.AutoScalingThresholds resource property to the template. + Adds an AWS::OpsWorks::Layer.AutoScalingThresholds resource property to the template. Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances. .DESCRIPTION Adds an AWS::OpsWorks::Layer.AutoScalingThresholds resource property to the template. - +Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html .PARAMETER CpuThreshold + The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-cputhreshold PrimitiveType: Double UpdateType: Mutable .PARAMETER IgnoreMetricsTime + The amount of time in minutes after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-ignoremetricstime PrimitiveType: Integer UpdateType: Mutable .PARAMETER InstanceCount + The number of instances to add or remove when the load exceeds a threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-instancecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER LoadThreshold + The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load computing: http://en.wikipedia.org/wiki/Load_%28computing%29. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-loadthreshold PrimitiveType: Double UpdateType: Mutable .PARAMETER MemoryThreshold + The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-memorythreshold PrimitiveType: Double UpdateType: Mutable .PARAMETER ThresholdsWaitTime + The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-thresholdwaittime PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLifecycleEventConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLifecycleEventConfiguration.ps1 index 7a36e9111..fa0546e24 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLifecycleEventConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLifecycleEventConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSOpsWorksLayerLifecycleEventConfiguration { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer.LifecycleEventConfiguration resource property to the template. + Adds an AWS::OpsWorks::Layer.LifecycleEventConfiguration resource property to the template. Specifies the lifecycle event configuration .DESCRIPTION Adds an AWS::OpsWorks::Layer.LifecycleEventConfiguration resource property to the template. - +Specifies the lifecycle event configuration .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html .PARAMETER ShutdownEventConfiguration + The Shutdown event configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration Type: ShutdownEventConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLoadBasedAutoScaling.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLoadBasedAutoScaling.ps1 index 4f18662ca..c3168ffc1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLoadBasedAutoScaling.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerLoadBasedAutoScaling.ps1 @@ -1,26 +1,32 @@ function Add-VSOpsWorksLayerLoadBasedAutoScaling { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer.LoadBasedAutoScaling resource property to the template. + Adds an AWS::OpsWorks::Layer.LoadBasedAutoScaling resource property to the template. Describes a layer's load-based auto scaling configuration. .DESCRIPTION Adds an AWS::OpsWorks::Layer.LoadBasedAutoScaling resource property to the template. - +Describes a layer's load-based auto scaling configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html .PARAMETER DownScaling + An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks Stacks reduces the number of instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-downscaling Type: AutoScalingThresholds UpdateType: Mutable .PARAMETER Enable + Whether load-based auto scaling is enabled for the layer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-enable PrimitiveType: Boolean UpdateType: Mutable .PARAMETER UpScaling + An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks Stacks increases the number of instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-upscaling Type: AutoScalingThresholds UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerRecipes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerRecipes.ps1 index 4a7bad87e..3bea6da1d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerRecipes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerRecipes.ps1 @@ -1,16 +1,20 @@ function Add-VSOpsWorksLayerRecipes { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer.Recipes resource property to the template. + Adds an AWS::OpsWorks::Layer.Recipes resource property to the template. AWS OpsWorks Stacks supports five lifecycle events: **setup**, **configuration**, **deploy**, **undeploy**, and **shutdown**. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events. .DESCRIPTION Adds an AWS::OpsWorks::Layer.Recipes resource property to the template. +AWS OpsWorks Stacks supports five lifecycle events: **setup**, **configuration**, **deploy**, **undeploy**, and **shutdown**. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events. +To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html .PARAMETER Configure + An array of custom recipe names to be run following a configure event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-configure DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +22,8 @@ function Add-VSOpsWorksLayerRecipes { UpdateType: Mutable .PARAMETER Deploy + An array of custom recipe names to be run following a deploy event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-deploy DuplicatesAllowed: False PrimitiveItemType: String @@ -25,6 +31,8 @@ function Add-VSOpsWorksLayerRecipes { UpdateType: Mutable .PARAMETER Setup + An array of custom recipe names to be run following a setup event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-setup DuplicatesAllowed: False PrimitiveItemType: String @@ -32,6 +40,8 @@ function Add-VSOpsWorksLayerRecipes { UpdateType: Mutable .PARAMETER Shutdown + An array of custom recipe names to be run following a shutdown event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-shutdown DuplicatesAllowed: False PrimitiveItemType: String @@ -39,6 +49,8 @@ function Add-VSOpsWorksLayerRecipes { UpdateType: Mutable .PARAMETER Undeploy + An array of custom recipe names to be run following a undeploy event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-undeploy DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerShutdownEventConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerShutdownEventConfiguration.ps1 index 7a5297b5f..0ceb38199 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerShutdownEventConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerShutdownEventConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSOpsWorksLayerShutdownEventConfiguration { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer.ShutdownEventConfiguration resource property to the template. + Adds an AWS::OpsWorks::Layer.ShutdownEventConfiguration resource property to the template. The Shutdown event configuration. .DESCRIPTION Adds an AWS::OpsWorks::Layer.ShutdownEventConfiguration resource property to the template. - +The Shutdown event configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html .PARAMETER DelayUntilElbConnectionsDrained + Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining: https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-delayuntilelbconnectionsdrained PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExecutionTimeout + The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-executiontimeout PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerVolumeConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerVolumeConfiguration.ps1 index cde533087..6e7ec4bdd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerVolumeConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksLayerVolumeConfiguration.ps1 @@ -1,46 +1,66 @@ function Add-VSOpsWorksLayerVolumeConfiguration { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer.VolumeConfiguration resource property to the template. + Adds an AWS::OpsWorks::Layer.VolumeConfiguration resource property to the template. Describes an Amazon EBS volume configuration. .DESCRIPTION Adds an AWS::OpsWorks::Layer.VolumeConfiguration resource property to the template. - +Describes an Amazon EBS volume configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html .PARAMETER Encrypted + Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS to provision for the volume. For PIOPS volumes, the IOPS per disk. +If you specify io1 for the volume type, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER MountPoint + The volume mount point. For example "/dev/sdh". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-mountpoint PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfDisks + The number of disks in the volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-numberofdisks PrimitiveType: Integer UpdateType: Mutable .PARAMETER RaidLevel + The volume RAID level: http://en.wikipedia.org/wiki/Standard_RAID_levels. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-raidlevel PrimitiveType: Integer UpdateType: Mutable .PARAMETER Size + The volume size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-size PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType + The volume type. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html. ++ standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. ++ io1 - Provisioned IOPS SSD. PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. ++ gp2 - General Purpose SSD. General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. ++ st1 - Throughput Optimized hard disk drive HDD. Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. ++ sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackChefConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackChefConfiguration.ps1 index edbc964c6..f8314a2ab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackChefConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackChefConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSOpsWorksStackChefConfiguration { <# .SYNOPSIS - Adds an AWS::OpsWorks::Stack.ChefConfiguration resource property to the template. + Adds an AWS::OpsWorks::Stack.ChefConfiguration resource property to the template. Describes the Chef configuration. .DESCRIPTION Adds an AWS::OpsWorks::Stack.ChefConfiguration resource property to the template. - +Describes the Chef configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html .PARAMETER BerkshelfVersion + The Berkshelf version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion PrimitiveType: String UpdateType: Mutable .PARAMETER ManageBerkshelf + Whether to enable Berkshelf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackElasticIp.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackElasticIp.ps1 index f94aecd34..47404f541 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackElasticIp.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackElasticIp.ps1 @@ -1,21 +1,25 @@ function Add-VSOpsWorksStackElasticIp { <# .SYNOPSIS - Adds an AWS::OpsWorks::Stack.ElasticIp resource property to the template. + Adds an AWS::OpsWorks::Stack.ElasticIp resource property to the template. Describes an Elastic IP address. .DESCRIPTION Adds an AWS::OpsWorks::Stack.ElasticIp resource property to the template. - +Describes an Elastic IP address. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html .PARAMETER Ip + The IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-ip PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackRdsDbInstance.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackRdsDbInstance.ps1 index eb0860308..960a69d96 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackRdsDbInstance.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackRdsDbInstance.ps1 @@ -1,26 +1,32 @@ function Add-VSOpsWorksStackRdsDbInstance { <# .SYNOPSIS - Adds an AWS::OpsWorks::Stack.RdsDbInstance resource property to the template. + Adds an AWS::OpsWorks::Stack.RdsDbInstance resource property to the template. Describes an Amazon RDS instance. .DESCRIPTION Adds an AWS::OpsWorks::Stack.RdsDbInstance resource property to the template. - +Describes an Amazon RDS instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html .PARAMETER DbPassword + AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword PrimitiveType: String UpdateType: Mutable .PARAMETER DbUser + The master user name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbuser PrimitiveType: String UpdateType: Mutable .PARAMETER RdsDbInstanceArn + The instance's ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-rdsdbinstancearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackSource.ps1 index 372af99b6..22de1ad72 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackSource.ps1 @@ -1,41 +1,60 @@ function Add-VSOpsWorksStackSource { <# .SYNOPSIS - Adds an AWS::OpsWorks::Stack.Source resource property to the template. + Adds an AWS::OpsWorks::Stack.Source resource property to the template. Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html or Custom Recipes and Cookbooks: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html. .DESCRIPTION Adds an AWS::OpsWorks::Stack.Source resource property to the template. - +Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html or Custom Recipes and Cookbooks: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html .PARAMETER Password + When included in a request, the parameter depends on the repository type. ++ For Amazon S3 bundles, set Password to the appropriate IAM secret access key. ++ For HTTP bundles and Subversion repositories, set Password to the password. +For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html: https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html. +In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-password PrimitiveType: String UpdateType: Mutable .PARAMETER Revision + The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision PrimitiveType: String UpdateType: Mutable .PARAMETER SshKey + The repository's SSH key. For more information, see Using Git Repository SSH Keys: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html in the *AWS OpsWorks User Guide*. To pass in an SSH key as a parameter, see the following example: +"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : "n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ... + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The repository type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url PrimitiveType: String UpdateType: Mutable .PARAMETER Username + This parameter depends on the repository type. ++ For Amazon S3 bundles, set Username to the appropriate IAM access key ID. ++ For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackStackConfigurationManager.ps1 b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackStackConfigurationManager.ps1 index ea192710d..8e79c5764 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackStackConfigurationManager.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSOpsWorksStackStackConfigurationManager.ps1 @@ -1,21 +1,25 @@ function Add-VSOpsWorksStackStackConfigurationManager { <# .SYNOPSIS - Adds an AWS::OpsWorks::Stack.StackConfigurationManager resource property to the template. + Adds an AWS::OpsWorks::Stack.StackConfigurationManager resource property to the template. Describes the configuration manager. .DESCRIPTION Adds an AWS::OpsWorks::Stack.StackConfigurationManager resource property to the template. - +Describes the configuration manager. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html .PARAMETER Name + The name. This parameter must be set to "Chef". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-name PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsCampaignHook.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsCampaignHook.ps1 index 40cb110c9..d3b9c1e8a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsCampaignHook.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsCampaignHook.ps1 @@ -1,26 +1,32 @@ function Add-VSPinpointApplicationSettingsCampaignHook { <# .SYNOPSIS - Adds an AWS::Pinpoint::ApplicationSettings.CampaignHook resource property to the template. + Adds an AWS::Pinpoint::ApplicationSettings.CampaignHook resource property to the template. Specifies the AWS Lambda function to use as a code hook for a campaign. .DESCRIPTION Adds an AWS::Pinpoint::ApplicationSettings.CampaignHook resource property to the template. - +Specifies the AWS Lambda function to use as a code hook for a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html .PARAMETER Mode + Specifies which Lambda mode to use when invoking the AWS Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-mode PrimitiveType: String UpdateType: Mutable .PARAMETER WebUrl + The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-weburl PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaFunctionName + The name or Amazon Resource Name ARN of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-lambdafunctionname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 index d887478ec..4f88a1d83 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 @@ -1,31 +1,39 @@ function Add-VSPinpointApplicationSettingsLimits { <# .SYNOPSIS - Adds an AWS::Pinpoint::ApplicationSettings.Limits resource property to the template. + Adds an AWS::Pinpoint::ApplicationSettings.Limits resource property to the template. The default sending limits for campaigns in the application. .DESCRIPTION Adds an AWS::Pinpoint::ApplicationSettings.Limits resource property to the template. - +The default sending limits for campaigns in the application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html .PARAMETER Daily + The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-daily PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaximumDuration + The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-maximumduration PrimitiveType: Integer UpdateType: Mutable .PARAMETER Total + The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-total PrimitiveType: Integer UpdateType: Mutable .PARAMETER MessagesPerSecond + The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-messagespersecond PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsQuietTime.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsQuietTime.ps1 index f14e67dc5..c2f5fd232 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsQuietTime.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsQuietTime.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointApplicationSettingsQuietTime { <# .SYNOPSIS - Adds an AWS::Pinpoint::ApplicationSettings.QuietTime resource property to the template. + Adds an AWS::Pinpoint::ApplicationSettings.QuietTime resource property to the template. Specifies the start and end times that define a time range when messages aren't sent to endpoints. .DESCRIPTION Adds an AWS::Pinpoint::ApplicationSettings.QuietTime resource property to the template. - +Specifies the start and end times that define a time range when messages aren't sent to endpoints. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html .PARAMETER Start + The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour with a leading zero, if applicable and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-start PrimitiveType: String UpdateType: Mutable .PARAMETER End + The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour with a leading zero, if applicable and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-end PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 index bed0135f3..243d137b0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointCampaignAttributeDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.AttributeDimension resource property to the template. + Adds an AWS::Pinpoint::Campaign.AttributeDimension resource property to the template. Specifies the criteria for including or excluding endpoints from a segment. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.AttributeDimension resource property to the template. - +Specifies the criteria for including or excluding endpoints from a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html .PARAMETER AttributeType + The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-attributetype PrimitiveType: String UpdateType: Mutable .PARAMETER Values + The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-values diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 index 27278fab7..2acdf6175 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 @@ -1,31 +1,39 @@ function Add-VSPinpointCampaignCampaignEmailMessage { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.CampaignEmailMessage resource property to the template. + Adds an AWS::Pinpoint::Campaign.CampaignEmailMessage resource property to the template. Specifies the content and "From" address for an email message that's sent to recipients of a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.CampaignEmailMessage resource property to the template. - +Specifies the content and "From" address for an email message that's sent to recipients of a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html .PARAMETER FromAddress + The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-fromaddress PrimitiveType: String UpdateType: Mutable .PARAMETER HtmlBody + The body of the email, in HTML format, for recipients whose email clients support HTML content. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-htmlbody PrimitiveType: String UpdateType: Mutable .PARAMETER Title + The subject line, or title, of the email. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-title PrimitiveType: String UpdateType: Mutable .PARAMETER Body + The body of the email for recipients whose email clients don't support HTML content. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-body PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 index 2867aa841..eae93d11f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointCampaignCampaignEventFilter { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.CampaignEventFilter resource property to the template. + Adds an AWS::Pinpoint::Campaign.CampaignEventFilter resource property to the template. Specifies the settings for events that cause a campaign to be sent. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.CampaignEventFilter resource property to the template. - +Specifies the settings for events that cause a campaign to be sent. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html .PARAMETER FilterType + The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event Events resource occurs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-filtertype PrimitiveType: String UpdateType: Mutable .PARAMETER Dimensions + The dimension settings of the event filter for the campaign. + Type: EventDimensions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-dimensions UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignHook.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignHook.ps1 index 86b6e7120..697ad69e7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignHook.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignHook.ps1 @@ -1,26 +1,32 @@ function Add-VSPinpointCampaignCampaignHook { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.CampaignHook resource property to the template. + Adds an AWS::Pinpoint::Campaign.CampaignHook resource property to the template. Specifies the AWS Lambda function to use as a code hook for a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.CampaignHook resource property to the template. - +Specifies the AWS Lambda function to use as a code hook for a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html .PARAMETER Mode + Specifies which Lambda mode to use when invoking the AWS Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-mode PrimitiveType: String UpdateType: Mutable .PARAMETER WebUrl + The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-weburl PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaFunctionName + The name or Amazon Resource Name ARN of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-lambdafunctionname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignSmsMessage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignSmsMessage.ps1 index 8a73f3f6e..ba9783b61 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignSmsMessage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignSmsMessage.ps1 @@ -1,26 +1,32 @@ function Add-VSPinpointCampaignCampaignSmsMessage { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.CampaignSmsMessage resource property to the template. + Adds an AWS::Pinpoint::Campaign.CampaignSmsMessage resource property to the template. Specifies the content and settings for an SMS message that's sent to recipients of a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.CampaignSmsMessage resource property to the template. - +Specifies the content and settings for an SMS message that's sent to recipients of a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html .PARAMETER SenderId + The sender ID to display on recipients' devices when they receive the SMS message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-senderid PrimitiveType: String UpdateType: Mutable .PARAMETER Body + The body of the SMS message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-body PrimitiveType: String UpdateType: Mutable .PARAMETER MessageType + The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-messagetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 index f1936496d..b6694b8dc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 @@ -1,26 +1,32 @@ function Add-VSPinpointCampaignEventDimensions { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.EventDimensions resource property to the template. + Adds an AWS::Pinpoint::Campaign.EventDimensions resource property to the template. Specifies the dimensions for an event filter that determines when a campaign is sent. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.EventDimensions resource property to the template. - +Specifies the dimensions for an event filter that determines when a campaign is sent. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html .PARAMETER Metrics + One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-metrics PrimitiveType: Json UpdateType: Mutable .PARAMETER EventType + The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-eventtype UpdateType: Mutable .PARAMETER Attributes + One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-attributes PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 index fedaf4bf5..33241c5fe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 @@ -1,31 +1,39 @@ function Add-VSPinpointCampaignLimits { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.Limits resource property to the template. + Adds an AWS::Pinpoint::Campaign.Limits resource property to the template. Specifies the limits on the messages that a campaign can send. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.Limits resource property to the template. - +Specifies the limits on the messages that a campaign can send. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html .PARAMETER Daily + The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-daily PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaximumDuration + The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-maximumduration PrimitiveType: Integer UpdateType: Mutable .PARAMETER Total + The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-total PrimitiveType: Integer UpdateType: Mutable .PARAMETER MessagesPerSecond + The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-messagespersecond PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 index 0a7ff775d..f52dcd03a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 @@ -1,71 +1,99 @@ function Add-VSPinpointCampaignMessage { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.Message resource property to the template. + Adds an AWS::Pinpoint::Campaign.Message resource property to the template. Specifies the content and settings for a push notification that's sent to recipients of a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.Message resource property to the template. - +Specifies the content and settings for a push notification that's sent to recipients of a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html .PARAMETER JsonBody + The JSON payload to use for a silent push notification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-jsonbody PrimitiveType: String UpdateType: Mutable .PARAMETER Action + The action to occur if a recipient taps the push notification. Valid values are: ++ OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. ++ DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. ++ URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-action PrimitiveType: String UpdateType: Mutable .PARAMETER MediaUrl + The URL of the image or video to display in the push notification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-mediaurl PrimitiveType: String UpdateType: Mutable .PARAMETER TimeToLive + The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. +This value doesn't apply to messages that are sent through the Amazon Device Messaging ADM service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-timetolive PrimitiveType: Integer UpdateType: Mutable .PARAMETER ImageSmallIconUrl + The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imagesmalliconurl PrimitiveType: String UpdateType: Mutable .PARAMETER ImageUrl + The URL of an image to display in the push notification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageurl PrimitiveType: String UpdateType: Mutable .PARAMETER Title + The title to display above the notification message on a recipient's device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-title PrimitiveType: String UpdateType: Mutable .PARAMETER ImageIconUrl + The URL of the image to display as the push-notification icon, such as the icon for the app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageiconurl PrimitiveType: String UpdateType: Mutable .PARAMETER SilentPush + Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-silentpush PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Body + The body of the notification message. The maximum number of characters is 200. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-body PrimitiveType: String UpdateType: Mutable .PARAMETER RawContent + The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-rawcontent PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 index 2c7dbb87f..80d0c53a8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 @@ -1,46 +1,60 @@ function Add-VSPinpointCampaignMessageConfiguration { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.MessageConfiguration resource property to the template. + Adds an AWS::Pinpoint::Campaign.MessageConfiguration resource property to the template. Specifies the message configuration settings for a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.MessageConfiguration resource property to the template. - +Specifies the message configuration settings for a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html .PARAMETER APNSMessage + The message that the campaign sends through the APNS Apple Push Notification service channel. This message overrides the default message. + Type: Message Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-apnsmessage UpdateType: Mutable .PARAMETER BaiduMessage + The message that the campaign sends through the Baidu Baidu Cloud Push channel. This message overrides the default message. + Type: Message Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-baidumessage UpdateType: Mutable .PARAMETER DefaultMessage + The default message that the campaign sends through all the channels that are configured for the campaign. + Type: Message Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-defaultmessage UpdateType: Mutable .PARAMETER EmailMessage + The message that the campaign sends through the email channel. + Type: CampaignEmailMessage Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-emailmessage UpdateType: Mutable .PARAMETER GCMMessage + The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging FCM, formerly Google Cloud Messaging GCM, service. This message overrides the default message. + Type: Message Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-gcmmessage UpdateType: Mutable .PARAMETER SMSMessage + The message that the campaign sends through the SMS channel. + Type: CampaignSmsMessage Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-smsmessage UpdateType: Mutable .PARAMETER ADMMessage + The message that the campaign sends through the ADM Amazon Device Messaging channel. This message overrides the default message. + Type: Message Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-admmessage UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 index bb8808de5..a3853c298 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointCampaignMetricDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.MetricDimension resource property to the template. + Adds an AWS::Pinpoint::Campaign.MetricDimension resource property to the template. Specifies the dimension settings for custom metrics that your app reports to Amazon Pinpoint. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.MetricDimension resource property to the template. - +Specifies the dimension settings for custom metrics that your app reports to Amazon Pinpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html .PARAMETER ComparisonOperator + The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value to compare. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-value PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignQuietTime.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignQuietTime.ps1 index 01fd660bd..68268aeb2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignQuietTime.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignQuietTime.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointCampaignQuietTime { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.QuietTime resource property to the template. + Adds an AWS::Pinpoint::Campaign.QuietTime resource property to the template. Specifies the start and end times that define a time range when messages aren't sent to endpoints. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.QuietTime resource property to the template. - +Specifies the start and end times that define a time range when messages aren't sent to endpoints. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule-quiettime.html .PARAMETER Start + The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour with a leading zero, if applicable and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule-quiettime.html#cfn-pinpoint-campaign-schedule-quiettime-start PrimitiveType: String UpdateType: Mutable .PARAMETER End + The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour with a leading zero, if applicable and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule-quiettime.html#cfn-pinpoint-campaign-schedule-quiettime-end PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 index 1974b9970..74cf3c203 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 @@ -1,46 +1,64 @@ function Add-VSPinpointCampaignSchedule { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.Schedule resource property to the template. + Adds an AWS::Pinpoint::Campaign.Schedule resource property to the template. Specifies the schedule settings for a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.Schedule resource property to the template. - +Specifies the schedule settings for a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html .PARAMETER TimeZone + The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-timezone PrimitiveType: String UpdateType: Mutable .PARAMETER QuietTime + The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met: +- The EndpointDemographic.Timezone property of the endpoint is set to a valid value. +- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign. +- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign. +If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled. + Type: QuietTime Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-quiettime UpdateType: Mutable .PARAMETER EndTime + The scheduled time, in ISO 8601 format, for the campaign to end. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-endtime PrimitiveType: String UpdateType: Mutable .PARAMETER StartTime + The scheduled time, in ISO 8601 format, for the campaign to begin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-starttime PrimitiveType: String UpdateType: Mutable .PARAMETER Frequency + Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-frequency PrimitiveType: String UpdateType: Mutable .PARAMETER EventFilter + The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT. + Type: CampaignEventFilter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-eventfilter UpdateType: Mutable .PARAMETER IsLocalTime + Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-islocaltime PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 index 613019bfd..77b336214 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointCampaignSetDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.SetDimension resource property to the template. + Adds an AWS::Pinpoint::Campaign.SetDimension resource property to the template. Specifies the dimension type and values for a segment. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.SetDimension resource property to the template. - +Specifies the dimension type and values for a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html .PARAMETER DimensionType + The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-dimensiontype PrimitiveType: String UpdateType: Mutable .PARAMETER Values + The criteria values for the segment dimension to use. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-values diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 index e8b098ba1..230c54504 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 @@ -1,36 +1,46 @@ function Add-VSPinpointCampaignWriteTreatmentResource { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.WriteTreatmentResource resource property to the template. + Adds an AWS::Pinpoint::Campaign.WriteTreatmentResource resource property to the template. Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.WriteTreatmentResource resource property to the template. - +Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html .PARAMETER TreatmentDescription + The custom description of the treatment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription PrimitiveType: String UpdateType: Mutable .PARAMETER MessageConfiguration + The message configuration settings for the treatment. + Type: MessageConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration UpdateType: Mutable .PARAMETER Schedule + The schedule settings for the treatment. + Type: Schedule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-schedule UpdateType: Mutable .PARAMETER SizePercent + The allocated percentage of users segment members to send the treatment to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-sizepercent PrimitiveType: Integer UpdateType: Mutable .PARAMETER TreatmentName + The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetDeliveryOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetDeliveryOptions.ps1 index b4eaab549..bbf926808 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetDeliveryOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetDeliveryOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointEmailConfigurationSetDeliveryOptions { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSet.DeliveryOptions resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSet.DeliveryOptions resource property to the template. Used to associate a configuration set with a dedicated IP pool. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSet.DeliveryOptions resource property to the template. - +Used to associate a configuration set with a dedicated IP pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-deliveryoptions.html .PARAMETER SendingPoolName + The name of the dedicated IP pool that you want to associate with the configuration set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-deliveryoptions.html#cfn-pinpointemail-configurationset-deliveryoptions-sendingpoolname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationCloudWatchDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationCloudWatchDestination.ps1 index 67f321419..d8ad667dd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationCloudWatchDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationCloudWatchDestination.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointEmailConfigurationSetEventDestinationCloudWatchDestination { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.CloudWatchDestination resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.CloudWatchDestination resource property to the template. An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.CloudWatchDestination resource property to the template. - +An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-cloudwatchdestination.html .PARAMETER DimensionConfigurations + An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-cloudwatchdestination.html#cfn-pinpointemail-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations ItemType: DimensionConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationDimensionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationDimensionConfiguration.ps1 index fb930f744..e412c6a1d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationDimensionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationDimensionConfiguration.ps1 @@ -1,26 +1,37 @@ function Add-VSPinpointEmailConfigurationSetEventDestinationDimensionConfiguration { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.DimensionConfiguration resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.DimensionConfiguration resource property to the template. An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.DimensionConfiguration resource property to the template. - +An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-dimensionconfiguration.html .PARAMETER DimensionValueSource + The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. Acceptable values: MESSAGE_TAG, EMAIL_HEADER, and LINK_TAG. +If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail API, choose MESSAGE_TAG. If you want Amazon Pinpoint to use your own email headers, choose EMAIL_HEADER. If you want Amazon Pinpoint to use tags that are specified in your links, choose LINK_TAG. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-dimensionconfiguration.html#cfn-pinpointemail-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultDimensionValue + The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: ++ It can only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ It can contain no more than 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-dimensionconfiguration.html#cfn-pinpointemail-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue PrimitiveType: String UpdateType: Mutable .PARAMETER DimensionName + The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: ++ It can only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ It can contain no more than 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-dimensionconfiguration.html#cfn-pinpointemail-configurationseteventdestination-dimensionconfiguration-dimensionname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationEventDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationEventDestination.ps1 index f4ad7cd22..befae5229 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationEventDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationEventDestination.ps1 @@ -1,42 +1,55 @@ function Add-VSPinpointEmailConfigurationSetEventDestinationEventDestination { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.EventDestination resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.EventDestination resource property to the template. In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.EventDestination resource property to the template. - +In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html .PARAMETER SnsDestination + An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. + Type: SnsDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-snsdestination UpdateType: Mutable .PARAMETER CloudWatchDestination + An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. + Type: CloudWatchDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-cloudwatchdestination UpdateType: Mutable .PARAMETER Enabled + If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition. +If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MatchingEventTypes + The types of events that Amazon Pinpoint sends to the specified event destinations. Acceptable values: SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, and RENDERING_FAILURE. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-matchingeventtypes UpdateType: Mutable .PARAMETER PinpointDestination + An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns. + Type: PinpointDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-pinpointdestination UpdateType: Mutable .PARAMETER KinesisFirehoseDestination + An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. + Type: KinesisFirehoseDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-kinesisfirehosedestination UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 index c2ef3884a..fd21cddf8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointEmailConfigurationSetEventDestinationKinesisFirehoseDestination { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.KinesisFirehoseDestination resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.KinesisFirehoseDestination resource property to the template. An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.KinesisFirehoseDestination resource property to the template. - +An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-kinesisfirehosedestination.html .PARAMETER DeliveryStreamArn + The Amazon Resource Name ARN of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-kinesisfirehosedestination.html#cfn-pinpointemail-configurationseteventdestination-kinesisfirehosedestination-deliverystreamarn PrimitiveType: String UpdateType: Mutable .PARAMETER IamRoleArn + The Amazon Resource Name ARN of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-kinesisfirehosedestination.html#cfn-pinpointemail-configurationseteventdestination-kinesisfirehosedestination-iamrolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationPinpointDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationPinpointDestination.ps1 index 67c8f50fc..4b30cf637 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationPinpointDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationPinpointDestination.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointEmailConfigurationSetEventDestinationPinpointDestination { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.PinpointDestination resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.PinpointDestination resource property to the template. An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.PinpointDestination resource property to the template. - +An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-pinpointdestination.html .PARAMETER ApplicationArn + The Amazon Resource Name ARN of the Amazon Pinpoint project that you want to send email events to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-pinpointdestination.html#cfn-pinpointemail-configurationseteventdestination-pinpointdestination-applicationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationSnsDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationSnsDestination.ps1 index bbb009bba..fdf7cb880 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationSnsDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetEventDestinationSnsDestination.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointEmailConfigurationSetEventDestinationSnsDestination { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.SnsDestination resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.SnsDestination resource property to the template. An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSetEventDestination.SnsDestination resource property to the template. - +An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-snsdestination.html .PARAMETER TopicArn + The Amazon Resource Name ARN of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-snsdestination.html#cfn-pinpointemail-configurationseteventdestination-snsdestination-topicarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetReputationOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetReputationOptions.ps1 index c81543353..404541e36 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetReputationOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetReputationOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointEmailConfigurationSetReputationOptions { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSet.ReputationOptions resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSet.ReputationOptions resource property to the template. Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSet.ReputationOptions resource property to the template. - +Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-reputationoptions.html .PARAMETER ReputationMetricsEnabled + If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-reputationoptions.html#cfn-pinpointemail-configurationset-reputationoptions-reputationmetricsenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetSendingOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetSendingOptions.ps1 index 60a1c4ba9..2c9c7de66 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetSendingOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetSendingOptions.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointEmailConfigurationSetSendingOptions { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSet.SendingOptions resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSet.SendingOptions resource property to the template. Used to enable or disable email sending for messages that use this configuration set in the current AWS Region. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSet.SendingOptions resource property to the template. - +Used to enable or disable email sending for messages that use this configuration set in the current AWS Region. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-sendingoptions.html .PARAMETER SendingEnabled + If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-sendingoptions.html#cfn-pinpointemail-configurationset-sendingoptions-sendingenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTags.ps1 index 79230ec0b..7a329be41 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTags.ps1 @@ -1,21 +1,26 @@ function Add-VSPinpointEmailConfigurationSetTags { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSet.Tags resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSet.Tags resource property to the template. An object that defines the tags (keys and values that you want to associate with the configuration set. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSet.Tags resource property to the template. - +An object that defines the tags (keys and values that you want to associate with the configuration set. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-tags.html .PARAMETER Value + The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-tags.html#cfn-pinpointemail-configurationset-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. +If you specify tags for the configuration set, then this value is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-tags.html#cfn-pinpointemail-configurationset-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTrackingOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTrackingOptions.ps1 index 7f8ede2c7..684980380 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTrackingOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailConfigurationSetTrackingOptions.ps1 @@ -1,16 +1,20 @@ function Add-VSPinpointEmailConfigurationSetTrackingOptions { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSet.TrackingOptions resource property to the template. + Adds an AWS::PinpointEmail::ConfigurationSet.TrackingOptions resource property to the template. An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. .DESCRIPTION Adds an AWS::PinpointEmail::ConfigurationSet.TrackingOptions resource property to the template. +An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. +These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-trackingoptions.html .PARAMETER CustomRedirectDomain + The domain that you want to use for tracking open and click events. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-trackingoptions.html#cfn-pinpointemail-configurationset-trackingoptions-customredirectdomain PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailDedicatedIpPoolTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailDedicatedIpPoolTags.ps1 index 24e7971f2..9cb6b0215 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailDedicatedIpPoolTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailDedicatedIpPoolTags.ps1 @@ -1,21 +1,26 @@ function Add-VSPinpointEmailDedicatedIpPoolTags { <# .SYNOPSIS - Adds an AWS::PinpointEmail::DedicatedIpPool.Tags resource property to the template. + Adds an AWS::PinpointEmail::DedicatedIpPool.Tags resource property to the template. An object that defines the tags (keys and values that you want to associate with the dedicated IP pool. .DESCRIPTION Adds an AWS::PinpointEmail::DedicatedIpPool.Tags resource property to the template. - +An object that defines the tags (keys and values that you want to associate with the dedicated IP pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-dedicatedippool-tags.html .PARAMETER Value + The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-dedicatedippool-tags.html#cfn-pinpointemail-dedicatedippool-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. +If you specify tags for the dedicated IP pool, then this value is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-dedicatedippool-tags.html#cfn-pinpointemail-dedicatedippool-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityMailFromAttributes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityMailFromAttributes.ps1 index a57dcd26c..176030a2a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityMailFromAttributes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityMailFromAttributes.ps1 @@ -1,21 +1,26 @@ function Add-VSPinpointEmailIdentityMailFromAttributes { <# .SYNOPSIS - Adds an AWS::PinpointEmail::Identity.MailFromAttributes resource property to the template. + Adds an AWS::PinpointEmail::Identity.MailFromAttributes resource property to the template. A list of attributes that are associated with a MAIL FROM domain. .DESCRIPTION Adds an AWS::PinpointEmail::Identity.MailFromAttributes resource property to the template. - +A list of attributes that are associated with a MAIL FROM domain. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-mailfromattributes.html .PARAMETER MailFromDomain + The name of a domain that an email identity uses as a custom MAIL FROM domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-mailfromattributes.html#cfn-pinpointemail-identity-mailfromattributes-mailfromdomain PrimitiveType: String UpdateType: Mutable .PARAMETER BehaviorOnMxFailure + The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses *amazonses.com* as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. +These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-mailfromattributes.html#cfn-pinpointemail-identity-mailfromattributes-behavioronmxfailure PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityTags.ps1 index 05809dceb..c8b77a4d2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointEmailIdentityTags.ps1 @@ -1,21 +1,26 @@ function Add-VSPinpointEmailIdentityTags { <# .SYNOPSIS - Adds an AWS::PinpointEmail::Identity.Tags resource property to the template. + Adds an AWS::PinpointEmail::Identity.Tags resource property to the template. An object that defines the tags (keys and values that you want to associate with the identity. .DESCRIPTION Adds an AWS::PinpointEmail::Identity.Tags resource property to the template. - +An object that defines the tags (keys and values that you want to associate with the identity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-tags.html .PARAMETER Value + The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-tags.html#cfn-pinpointemail-identity-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. +If you specify tags for the identity, then this value is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-tags.html#cfn-pinpointemail-identity-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 index 345d4cd56..242a2a49a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointSegmentAttributeDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.AttributeDimension resource property to the template. + Adds an AWS::Pinpoint::Segment.AttributeDimension resource property to the template. Specifies the criteria for including or excluding endpoints from a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.AttributeDimension resource property to the template. - +Specifies the criteria for including or excluding endpoints from a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html .PARAMETER AttributeType + The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html#cfn-pinpoint-segment-attributedimension-attributetype PrimitiveType: String UpdateType: Mutable .PARAMETER Values + The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html#cfn-pinpoint-segment-attributedimension-values diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 index 10f2c78d9..49c65938c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 @@ -1,16 +1,18 @@ function Add-VSPinpointSegmentBehavior { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Behavior resource property to the template. + Adds an AWS::Pinpoint::Segment.Behavior resource property to the template. The behavior-based criteria for the segment, such as how recently users have used your app. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Behavior resource property to the template. - +The behavior-based criteria for the segment, such as how recently users have used your app. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior.html .PARAMETER Recency + Specifies how recently segment members were active. + Type: Recency Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior.html#cfn-pinpoint-segment-segmentdimensions-behavior-recency UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 index a1e20a78c..4283de2e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointSegmentCoordinates { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Coordinates resource property to the template. + Adds an AWS::Pinpoint::Segment.Coordinates resource property to the template. The latitude and longitude of the location. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Coordinates resource property to the template. - +The latitude and longitude of the location. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates.html .PARAMETER Latitude + The latitude coordinate of the location. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates.html#cfn-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates-latitude PrimitiveType: Double UpdateType: Mutable .PARAMETER Longitude + The longitude coordinate of the location. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates.html#cfn-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates-longitude PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 index bd3b54b09..bd83130d1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 @@ -1,41 +1,53 @@ function Add-VSPinpointSegmentDemographic { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Demographic resource property to the template. + Adds an AWS::Pinpoint::Segment.Demographic resource property to the template. The demographic-based criteria, such as device platform, for the segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Demographic resource property to the template. - +The demographic-based criteria, such as device platform, for the segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html .PARAMETER AppVersion + The app version criteria for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html#cfn-pinpoint-segment-segmentdimensions-demographic-appversion UpdateType: Mutable .PARAMETER DeviceType + The device type criteria for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html#cfn-pinpoint-segment-segmentdimensions-demographic-devicetype UpdateType: Mutable .PARAMETER Platform + The device platform criteria for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html#cfn-pinpoint-segment-segmentdimensions-demographic-platform UpdateType: Mutable .PARAMETER Channel + The channel criteria for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html#cfn-pinpoint-segment-segmentdimensions-demographic-channel UpdateType: Mutable .PARAMETER Model + The device model criteria for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html#cfn-pinpoint-segment-segmentdimensions-demographic-model UpdateType: Mutable .PARAMETER Make + The device make criteria for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html#cfn-pinpoint-segment-segmentdimensions-demographic-make UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 index 8dce4c397..0625130f5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointSegmentGPSPoint { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.GPSPoint resource property to the template. + Adds an AWS::Pinpoint::Segment.GPSPoint resource property to the template. The GPS coordinates of the endpoint location. .DESCRIPTION Adds an AWS::Pinpoint::Segment.GPSPoint resource property to the template. - +The GPS coordinates of the endpoint location. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint.html .PARAMETER RangeInKilometers + The range, in kilometers, from the GPS coordinates. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint.html#cfn-pinpoint-segment-segmentdimensions-location-gpspoint-rangeinkilometers PrimitiveType: Double UpdateType: Mutable .PARAMETER Coordinates + The GPS coordinates to measure distance from. + Type: Coordinates Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint.html#cfn-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 index cf6418de7..67b4462a0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 @@ -1,32 +1,41 @@ function Add-VSPinpointSegmentGroups { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Groups resource property to the template. + Adds an AWS::Pinpoint::Segment.Groups resource property to the template. An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Groups resource property to the template. - +An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html .PARAMETER Type + Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html#cfn-pinpoint-segment-segmentgroups-groups-type PrimitiveType: String UpdateType: Mutable .PARAMETER SourceType + Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html#cfn-pinpoint-segment-segmentgroups-groups-sourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Dimensions + An array that defines the dimensions to include or exclude from the segment. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html#cfn-pinpoint-segment-segmentgroups-groups-dimensions ItemType: SegmentDimensions UpdateType: Mutable .PARAMETER SourceSegments + The base segment to build the segment on. A base segment, also called a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. +You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html#cfn-pinpoint-segment-segmentgroups-groups-sourcesegments ItemType: SourceSegments diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 index 6d2461f8e..660117e61 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointSegmentLocation { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Location resource property to the template. + Adds an AWS::Pinpoint::Segment.Location resource property to the template. The location-based criteria, such as region or GPS coordinates, for the segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Location resource property to the template. - +The location-based criteria, such as region or GPS coordinates, for the segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location.html .PARAMETER GPSPoint + The GPS point dimension for the segment. + Type: GPSPoint Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location.html#cfn-pinpoint-segment-segmentdimensions-location-gpspoint UpdateType: Mutable .PARAMETER Country + The country or region code, in ISO 3166-1 alpha-2 format, for the segment. + Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location.html#cfn-pinpoint-segment-segmentdimensions-location-country UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 index 5399eafe0..e117839c9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 @@ -1,21 +1,26 @@ function Add-VSPinpointSegmentRecency { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Recency resource property to the template. + Adds an AWS::Pinpoint::Segment.Recency resource property to the template. Specifies how recently segment members were active. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Recency resource property to the template. - +Specifies how recently segment members were active. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior-recency.html .PARAMETER Duration + The duration to use when determining which users have been active or inactive with your app. +Possible values: HR_24 | DAY_7 | DAY_14 | DAY_30. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior-recency.html#cfn-pinpoint-segment-segmentdimensions-behavior-recency-duration PrimitiveType: String UpdateType: Mutable .PARAMETER RecencyType + The type of recency dimension to use for the segment. Valid values are: ACTIVE and INACTIVE. If the value is ACTIVE, the segment includes users who have used your app within the specified duration are included in the segment. If the value is INACTIVE, the segment includes users who haven't used your app within the specified duration are included in the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior-recency.html#cfn-pinpoint-segment-segmentdimensions-behavior-recency-recencytype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentDimensions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentDimensions.ps1 index 250b56232..a2dc4d4f3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentDimensions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentDimensions.ps1 @@ -1,41 +1,53 @@ function Add-VSPinpointSegmentSegmentDimensions { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SegmentDimensions resource property to the template. + Adds an AWS::Pinpoint::Segment.SegmentDimensions resource property to the template. Specifies the dimension settings for a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SegmentDimensions resource property to the template. - +Specifies the dimension settings for a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html .PARAMETER Demographic + The demographic-based criteria, such as device platform, for the segment. + Type: Demographic Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-demographic UpdateType: Mutable .PARAMETER Metrics + One or more custom metrics to use as criteria for the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-metrics PrimitiveType: Json UpdateType: Mutable .PARAMETER Attributes + One or more custom attributes to use as criteria for the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-attributes PrimitiveType: Json UpdateType: Mutable .PARAMETER Behavior + The behavior-based criteria, such as how recently users have used your app, for the segment. + Type: Behavior Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-behavior UpdateType: Mutable .PARAMETER UserAttributes + One or more custom user attributes to use as criteria for the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-userattributes PrimitiveType: Json UpdateType: Mutable .PARAMETER Location + The location-based criteria, such as region or GPS coordinates, for the segment. + Type: Location Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-location UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 index 07e3611f9..457b168df 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 @@ -1,22 +1,26 @@ function Add-VSPinpointSegmentSegmentGroups { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SegmentGroups resource property to the template. + Adds an AWS::Pinpoint::Segment.SegmentGroups resource property to the template. Specifies the set of segment criteria to evaluate when handling segment groups for the segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SegmentGroups resource property to the template. - +Specifies the set of segment criteria to evaluate when handling segment groups for the segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html .PARAMETER Groups + Specifies the set of segment criteria to evaluate when handling segment groups for the segment. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-groups ItemType: Groups UpdateType: Mutable .PARAMETER Include + Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-include PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 index 7df9ab630..f190e1d42 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 @@ -1,21 +1,25 @@ function Add-VSPinpointSegmentSetDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SetDimension resource property to the template. + Adds an AWS::Pinpoint::Segment.SetDimension resource property to the template. Specifies the dimension type and values for a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SetDimension resource property to the template. - +Specifies the dimension type and values for a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html .PARAMETER DimensionType + The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-dimensiontype PrimitiveType: String UpdateType: Mutable .PARAMETER Values + The criteria values for the segment dimension to use. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-values diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 index da2faeb79..3672ad8e0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 @@ -1,21 +1,27 @@ function Add-VSPinpointSegmentSourceSegments { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SourceSegments resource property to the template. + Adds an AWS::Pinpoint::Segment.SourceSegments resource property to the template. The base segment to build the segment on. A base segment, also called a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SourceSegments resource property to the template. +The base segment to build the segment on. A base segment, also called a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. +You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups-sourcesegments.html .PARAMETER Version + The version number of the source segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups-sourcesegments.html#cfn-pinpoint-segment-segmentgroups-groups-sourcesegments-version PrimitiveType: Integer UpdateType: Mutable .PARAMETER Id + The unique ID of the source segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups-sourcesegments.html#cfn-pinpoint-segment-segmentgroups-groups-sourcesegments-id PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterDBClusterRole.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterDBClusterRole.ps1 index 6103e5a2b..0fc1dee3f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterDBClusterRole.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterDBClusterRole.ps1 @@ -1,21 +1,25 @@ function Add-VSRDSDBClusterDBClusterRole { <# .SYNOPSIS - Adds an AWS::RDS::DBCluster.DBClusterRole resource property to the template. + Adds an AWS::RDS::DBCluster.DBClusterRole resource property to the template. Describes an AWS Identity and Access Management (IAM role that is associated with a DB cluster. .DESCRIPTION Adds an AWS::RDS::DBCluster.DBClusterRole resource property to the template. - +Describes an AWS Identity and Access Management (IAM role that is associated with a DB cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html .PARAMETER FeatureName + The name of the feature associated with the AWS Identity and Access Management IAM role. For the list of supported feature names, see DBEngineVersion: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html in the *Amazon RDS API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-featurename PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role that is associated with the DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 index daaa497a0..ba439efdc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 @@ -1,31 +1,46 @@ function Add-VSRDSDBClusterScalingConfiguration { <# .SYNOPSIS - Adds an AWS::RDS::DBCluster.ScalingConfiguration resource property to the template. + Adds an AWS::RDS::DBCluster.ScalingConfiguration resource property to the template. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. .DESCRIPTION Adds an AWS::RDS::DBCluster.ScalingConfiguration resource property to the template. +The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. +For more information, see Using Amazon Aurora Serverless: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html in the *Amazon Aurora User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html .PARAMETER AutoPause + A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle it has no connections. +If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MaxCapacity + The maximum capacity for an Aurora DB cluster in serverless DB engine mode. +Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +The maximum capacity must be greater than or equal to the minimum capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinCapacity + The minimum capacity for an Aurora DB cluster in serverless DB engine mode. +Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +The minimum capacity must be less than or equal to the maximum capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER SecondsUntilAutoPause + The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 index 738192001..2d9fe26ee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 @@ -1,21 +1,25 @@ function Add-VSRDSDBInstanceDBInstanceRole { <# .SYNOPSIS - Adds an AWS::RDS::DBInstance.DBInstanceRole resource property to the template. + Adds an AWS::RDS::DBInstance.DBInstanceRole resource property to the template. Describes an AWS Identity and Access Management (IAM role that is associated with a DB instance. .DESCRIPTION Adds an AWS::RDS::DBInstance.DBInstanceRole resource property to the template. - +Describes an AWS Identity and Access Management (IAM role that is associated with a DB instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html .PARAMETER FeatureName + The name of the feature associated with the AWS Identity and Access Management IAM role. For the list of supported feature names, see DBEngineVersion. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-featurename PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role that is associated with the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceProcessorFeature.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceProcessorFeature.ps1 index 21171f7fb..323f96a95 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceProcessorFeature.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceProcessorFeature.ps1 @@ -1,21 +1,25 @@ function Add-VSRDSDBInstanceProcessorFeature { <# .SYNOPSIS - Adds an AWS::RDS::DBInstance.ProcessorFeature resource property to the template. + Adds an AWS::RDS::DBInstance.ProcessorFeature resource property to the template. The ProcessorFeature property type specifies the processor features of a DB instance class status. .DESCRIPTION Adds an AWS::RDS::DBInstance.ProcessorFeature resource property to the template. - +The ProcessorFeature property type specifies the processor features of a DB instance class status. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html .PARAMETER Name + The name of the processor feature. Valid names are coreCount and threadsPerCore. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of a processor feature name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 index 8ebd7125b..b49a33ec7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 @@ -1,31 +1,39 @@ function Add-VSRDSDBSecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::RDS::DBSecurityGroup.Ingress resource property to the template. + Adds an AWS::RDS::DBSecurityGroup.Ingress resource property to the template. The Ingress property type specifies an individual ingress rule within an AWS::RDS::DBSecurityGroup resource. .DESCRIPTION Adds an AWS::RDS::DBSecurityGroup.Ingress resource property to the template. - +The Ingress property type specifies an individual ingress rule within an AWS::RDS::DBSecurityGroup resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html .PARAMETER CIDRIP + The IP range to authorize. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-cidrip PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupId + Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupid PrimitiveType: String UpdateType: Immutable .PARAMETER EC2SecurityGroupName + Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupname PrimitiveType: String UpdateType: Immutable .PARAMETER EC2SecurityGroupOwnerId + AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupownerid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 index 1696ff810..ca4c7bd84 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSRDSOptionGroupOptionConfiguration { <# .SYNOPSIS - Adds an AWS::RDS::OptionGroup.OptionConfiguration resource property to the template. + Adds an AWS::RDS::OptionGroup.OptionConfiguration resource property to the template. The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource. .DESCRIPTION Adds an AWS::RDS::OptionGroup.OptionConfiguration resource property to the template. - +The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html .PARAMETER DBSecurityGroupMemberships + A list of DBSecurityGroupMemebrship name strings used for this option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-dbsecuritygroupmemberships DuplicatesAllowed: True PrimitiveItemType: String @@ -18,11 +20,15 @@ function Add-VSRDSOptionGroupOptionConfiguration { UpdateType: Mutable .PARAMETER OptionName + The configuration of options to include in a group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-optionname PrimitiveType: String UpdateType: Mutable .PARAMETER OptionSettings + The option settings to include in an option group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-optionsettings DuplicatesAllowed: False ItemType: OptionSetting @@ -30,16 +36,22 @@ function Add-VSRDSOptionGroupOptionConfiguration { UpdateType: Mutable .PARAMETER OptionVersion + The version for the option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfiguration-optionversion PrimitiveType: String UpdateType: Mutable .PARAMETER Port + The optional port for the option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER VpcSecurityGroupMemberships + A list of VpcSecurityGroupMembership name strings used for this option. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-vpcsecuritygroupmemberships DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionSetting.ps1 index d7eaaf2da..2d2e6938c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionSetting.ps1 @@ -1,21 +1,25 @@ function Add-VSRDSOptionGroupOptionSetting { <# .SYNOPSIS - Adds an AWS::RDS::OptionGroup.OptionSetting resource property to the template. + Adds an AWS::RDS::OptionGroup.OptionSetting resource property to the template. The OptionSetting property type specifies the value for an option within an OptionSetting property. .DESCRIPTION Adds an AWS::RDS::OptionGroup.OptionSetting resource property to the template. - +The OptionSetting property type specifies the value for an option within an OptionSetting property. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html .PARAMETER Name + The name of the option that has settings that you can set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html#cfn-rds-optiongroup-optionconfigurations-optionsettings-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The current value of the option setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html#cfn-rds-optiongroup-optionconfigurations-optionsettings-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterLoggingProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterLoggingProperties.ps1 index fa939f24c..c96430acc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterLoggingProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterLoggingProperties.ps1 @@ -1,21 +1,36 @@ function Add-VSRedshiftClusterLoggingProperties { <# .SYNOPSIS - Adds an AWS::Redshift::Cluster.LoggingProperties resource property to the template. + Adds an AWS::Redshift::Cluster.LoggingProperties resource property to the template. Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. .DESCRIPTION Adds an AWS::Redshift::Cluster.LoggingProperties resource property to the template. - +Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html .PARAMETER BucketName + The name of an existing S3 bucket where the log files are to be stored. +Constraints: ++ Must be in the same region as the cluster ++ The cluster must have read bucket and put object permissions + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER S3KeyPrefix + The prefix applied to the log file names. +Constraints: ++ Cannot exceed 512 characters ++ Cannot contain spaces , double quotes ", single quotes ', a backslash , or control characters. The hexadecimal codes for invalid characters are: ++ x00 to x20 ++ x22 ++ x27 ++ x5c ++ x7f or larger + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterParameterGroupParameter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterParameterGroupParameter.ps1 index e6856822c..bb53e05ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterParameterGroupParameter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRedshiftClusterParameterGroupParameter.ps1 @@ -1,21 +1,25 @@ function Add-VSRedshiftClusterParameterGroupParameter { <# .SYNOPSIS - Adds an AWS::Redshift::ClusterParameterGroup.Parameter resource property to the template. + Adds an AWS::Redshift::ClusterParameterGroup.Parameter resource property to the template. Describes a parameter in a cluster parameter group. .DESCRIPTION Adds an AWS::Redshift::ClusterParameterGroup.Parameter resource property to the template. - +Describes a parameter in a cluster parameter group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html .PARAMETER ParameterName + The name of the parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametername PrimitiveType: String UpdateType: Mutable .PARAMETER ParameterValue + The value of the parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametervalue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 index 023b887ea..1ee8f6cef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 @@ -1,21 +1,25 @@ function Add-VSRoboMakerRobotApplicationRobotSoftwareSuite { <# .SYNOPSIS - Adds an AWS::RoboMaker::RobotApplication.RobotSoftwareSuite resource property to the template. + Adds an AWS::RoboMaker::RobotApplication.RobotSoftwareSuite resource property to the template. Information about a robot software suite. .DESCRIPTION Adds an AWS::RoboMaker::RobotApplication.RobotSoftwareSuite resource property to the template. - +Information about a robot software suite. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html .PARAMETER Version + The version of the robot software suite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html#cfn-robomaker-robotapplication-robotsoftwaresuite-version PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the robot software suite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html#cfn-robomaker-robotapplication-robotsoftwaresuite-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationSourceConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationSourceConfig.ps1 index 6286d7af5..77058c304 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationSourceConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationSourceConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSRoboMakerRobotApplicationSourceConfig { <# .SYNOPSIS - Adds an AWS::RoboMaker::RobotApplication.SourceConfig resource property to the template. + Adds an AWS::RoboMaker::RobotApplication.SourceConfig resource property to the template. Information about a source configuration. .DESCRIPTION Adds an AWS::RoboMaker::RobotApplication.SourceConfig resource property to the template. - +Information about a source configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html .PARAMETER S3Bucket + The Amazon S3 bucket name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html#cfn-robomaker-robotapplication-sourceconfig-s3bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Architecture + The target processor architecture for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html#cfn-robomaker-robotapplication-sourceconfig-architecture PrimitiveType: String UpdateType: Mutable .PARAMETER S3Key + The s3 object key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html#cfn-robomaker-robotapplication-sourceconfig-s3key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRenderingEngine.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRenderingEngine.ps1 index 657b38c58..1c50df363 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRenderingEngine.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRenderingEngine.ps1 @@ -1,21 +1,25 @@ function Add-VSRoboMakerSimulationApplicationRenderingEngine { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplication.RenderingEngine resource property to the template. + Adds an AWS::RoboMaker::SimulationApplication.RenderingEngine resource property to the template. Information about a rendering engine. .DESCRIPTION Adds an AWS::RoboMaker::SimulationApplication.RenderingEngine resource property to the template. - +Information about a rendering engine. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html .PARAMETER Version + The version of the rendering engine. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html#cfn-robomaker-simulationapplication-renderingengine-version PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the rendering engine. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html#cfn-robomaker-simulationapplication-renderingengine-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 index 901453f3a..24202e6e3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 @@ -1,21 +1,25 @@ function Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite resource property to the template. + Adds an AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite resource property to the template. Information about a robot software suite. .DESCRIPTION Adds an AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite resource property to the template. - +Information about a robot software suite. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html .PARAMETER Version + The version of the robot software suite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html#cfn-robomaker-simulationapplication-robotsoftwaresuite-version PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the robot software suite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html#cfn-robomaker-simulationapplication-robotsoftwaresuite-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSimulationSoftwareSuite.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSimulationSoftwareSuite.ps1 index f2e337d73..328fecc78 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSimulationSoftwareSuite.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSimulationSoftwareSuite.ps1 @@ -1,21 +1,25 @@ function Add-VSRoboMakerSimulationApplicationSimulationSoftwareSuite { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite resource property to the template. + Adds an AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite resource property to the template. Information about a simulation software suite. .DESCRIPTION Adds an AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite resource property to the template. - +Information about a simulation software suite. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html .PARAMETER Version + The version of the simulation software suite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html#cfn-robomaker-simulationapplication-simulationsoftwaresuite-version PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the simulation software suite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html#cfn-robomaker-simulationapplication-simulationsoftwaresuite-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSourceConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSourceConfig.ps1 index 19a7c0a30..5f87d0d82 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSourceConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationSourceConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSRoboMakerSimulationApplicationSourceConfig { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplication.SourceConfig resource property to the template. + Adds an AWS::RoboMaker::SimulationApplication.SourceConfig resource property to the template. Information about a source configuration. .DESCRIPTION Adds an AWS::RoboMaker::SimulationApplication.SourceConfig resource property to the template. - +Information about a source configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html .PARAMETER S3Bucket + The Amazon S3 bucket name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html#cfn-robomaker-simulationapplication-sourceconfig-s3bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Architecture + The target processor architecture for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html#cfn-robomaker-simulationapplication-sourceconfig-architecture PrimitiveType: String UpdateType: Mutable .PARAMETER S3Key + The s3 object key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html#cfn-robomaker-simulationapplication-sourceconfig-s3key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 index 6435a3ec9..b969744cd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 @@ -1,21 +1,29 @@ function Add-VSRoute53HealthCheckAlarmIdentifier { <# .SYNOPSIS - Adds an AWS::Route53::HealthCheck.AlarmIdentifier resource property to the template. + Adds an AWS::Route53::HealthCheck.AlarmIdentifier resource property to the template. A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. .DESCRIPTION Adds an AWS::Route53::HealthCheck.AlarmIdentifier resource property to the template. - +A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html .PARAMETER Name + The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. +Route 53 supports CloudWatch alarms with the following features: ++ Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics in the *Amazon CloudWatch User Guide*. ++ Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name PrimitiveType: String UpdateType: Mutable .PARAMETER Region + For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. +For the current list of CloudWatch regions, see Amazon CloudWatch: http://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region in the *AWS Regions and Endpoints* chapter of the *Amazon Web Services General Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 index 2e8fa77bb..2ab358dd8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSRoute53HealthCheckHealthCheckConfig { <# .SYNOPSIS - Adds an AWS::Route53::HealthCheck.HealthCheckConfig resource property to the template. + Adds an AWS::Route53::HealthCheck.HealthCheckConfig resource property to the template. A complex type that contains information about the health check. .DESCRIPTION Adds an AWS::Route53::HealthCheck.HealthCheckConfig resource property to the template. - +A complex type that contains information about the health check. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html .PARAMETER AlarmIdentifier + A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier Type: AlarmIdentifier UpdateType: Mutable .PARAMETER ChildHealthChecks + CALCULATED Health Checks Only A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks DuplicatesAllowed: False PrimitiveItemType: String @@ -23,51 +27,106 @@ function Add-VSRoute53HealthCheckHealthCheckConfig { UpdateType: Mutable .PARAMETER EnableSNI + Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate. +Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. +The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni PrimitiveType: Boolean UpdateType: Mutable .PARAMETER FailureThreshold + The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html in the *Amazon Route 53 Developer Guide*. +If you don't specify a value for FailureThreshold, the default value is three health checks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold PrimitiveType: Integer UpdateType: Mutable .PARAMETER FullyQualifiedDomainName + Amazon Route 53 behavior depends on whether you specify a value for IPAddress. +**If you specify a value for** IPAddress: +Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. +When Route 53 checks the health of an endpoint, here is how it constructs the Host header: ++ If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. ++ If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. ++ If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header. +If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases. +**If you don't specify a value for IPAddress **: +Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. +If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error. +If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server such as us-east-2-www.example.com, not the name of the resource record sets www.example.com. +In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. +In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname PrimitiveType: String UpdateType: Mutable .PARAMETER HealthThreshold + The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks element. +Note the following: ++ If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy. ++ If you specify 0, Route 53 always considers this health check to be healthy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold PrimitiveType: Integer UpdateType: Mutable .PARAMETER IPAddress + The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint. +Use one of the following formats for the value of IPAddress: ++ **IPv4 address**: four values between 0 and 255, separated by periods ., for example, 192.0.2.44. ++ **IPv6 address**: eight groups of four hexadecimal values, separated by colons :, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345. +If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change. +For more information, see FullyQualifiedDomainName: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName. +Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: ++ RFC 5735, Special Use IPv4 Addresses: https://tools.ietf.org/html/rfc5735 ++ RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space: https://tools.ietf.org/html/rfc6598 ++ RFC 5156, Special-Use IPv6 Addresses: https://tools.ietf.org/html/rfc5156 +When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress PrimitiveType: String UpdateType: Mutable .PARAMETER InsufficientDataHealthStatus + When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: ++ Healthy: Route 53 considers the health check to be healthy. ++ Unhealthy: Route 53 considers the health check to be unhealthy. ++ LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus PrimitiveType: String UpdateType: Mutable .PARAMETER Inverted + Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MeasureLatency + Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the **Health Checks** page in the Route 53 console. +You can't change the value of MeasureLatency after you create a health check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Port + The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER Regions + A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint. +If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under **Valid Values**. +If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint for example, if you replace three regions with four different regions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions DuplicatesAllowed: False PrimitiveItemType: String @@ -75,21 +134,44 @@ function Add-VSRoute53HealthCheckHealthCheckConfig { UpdateType: Mutable .PARAMETER RequestInterval + The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval. +You can't change the value of RequestInterval after you create a health check. +If you don't specify a value for RequestInterval, the default value is 30 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval PrimitiveType: Integer UpdateType: Immutable .PARAMETER ResourcePath + The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath PrimitiveType: String UpdateType: Mutable .PARAMETER SearchString + If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. +Route 53 considers case when searching for SearchString in the response body. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. +You can't change the value of Type after you create a health check. +You can create the following types of health checks: ++ **HTTP**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. ++ **HTTPS**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. +**Important** +If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later. ++ **HTTP_STR_MATCH**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString. ++ **HTTPS_STR_MATCH**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString. ++ **TCP**: Route 53 tries to establish a TCP connection. ++ **CLOUDWATCH_METRIC**: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus. ++ **CALCULATED**: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold. +For more information, see How Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckTag.ps1 index 757308da4..2d457fd45 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckTag.ps1 @@ -1,21 +1,31 @@ function Add-VSRoute53HealthCheckHealthCheckTag { <# .SYNOPSIS - Adds an AWS::Route53::HealthCheck.HealthCheckTag resource property to the template. + Adds an AWS::Route53::HealthCheck.HealthCheckTag resource property to the template. The HealthCheckTag property describes one key-value pair that is associated with an AWS::Route53::HealthCheck resource. .DESCRIPTION Adds an AWS::Route53::HealthCheck.HealthCheckTag resource property to the template. - +The HealthCheckTag property describes one key-value pair that is associated with an AWS::Route53::HealthCheck resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html .PARAMETER Key + The value of Key depends on the operation that you want to perform: ++ **Add a tag to a health check or hosted zone**: Key is the name that you want to give the new tag. ++ **Edit a tag**: Key is the name of the tag that you want to change the Value for. ++ ** Delete a key**: Key is the name of the tag you want to remove. ++ **Give a name to a health check**: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a **Name** column that lets you see the name that you've given to each health check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthchecktags-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of Value depends on the operation that you want to perform: ++ **Add a tag to a health check or hosted zone**: Value is the value that you want to give the new tag. ++ **Edit a tag**: Value is the new value that you want to assign the tag. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthchecktags-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneConfig.ps1 index 28f983f94..4b9bcc0b3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSRoute53HostedZoneHostedZoneConfig { <# .SYNOPSIS - Adds an AWS::Route53::HostedZone.HostedZoneConfig resource property to the template. + Adds an AWS::Route53::HostedZone.HostedZoneConfig resource property to the template. A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements. .DESCRIPTION Adds an AWS::Route53::HostedZone.HostedZoneConfig resource property to the template. - +A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html .PARAMETER Comment + Any comments that you want to include about the hosted zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneTag.ps1 index f70472a1f..49531525a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneHostedZoneTag.ps1 @@ -1,21 +1,31 @@ function Add-VSRoute53HostedZoneHostedZoneTag { <# .SYNOPSIS - Adds an AWS::Route53::HostedZone.HostedZoneTag resource property to the template. + Adds an AWS::Route53::HostedZone.HostedZoneTag resource property to the template. A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone. .DESCRIPTION Adds an AWS::Route53::HostedZone.HostedZoneTag resource property to the template. - +A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html .PARAMETER Key + The value of Key depends on the operation that you want to perform: ++ **Add a tag to a health check or hosted zone**: Key is the name that you want to give the new tag. ++ **Edit a tag**: Key is the name of the tag that you want to change the Value for. ++ ** Delete a key**: Key is the name of the tag you want to remove. ++ **Give a name to a health check**: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a **Name** column that lets you see the name that you've given to each health check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value of Value depends on the operation that you want to perform: ++ **Add a tag to a health check or hosted zone**: Value is the value that you want to give the new tag. ++ **Edit a tag**: Value is the new value that you want to assign the tag. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneQueryLoggingConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneQueryLoggingConfig.ps1 index 7a1393fff..8d8b102c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneQueryLoggingConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneQueryLoggingConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSRoute53HostedZoneQueryLoggingConfig { <# .SYNOPSIS - Adds an AWS::Route53::HostedZone.QueryLoggingConfig resource property to the template. + Adds an AWS::Route53::HostedZone.QueryLoggingConfig resource property to the template. A complex type that contains information about a configuration for DNS query logging. .DESCRIPTION Adds an AWS::Route53::HostedZone.QueryLoggingConfig resource property to the template. - +A complex type that contains information about a configuration for DNS query logging. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html .PARAMETER CloudWatchLogsLogGroupArn + The Amazon Resource Name ARN of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 index a259f67d4..d4cd63891 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 @@ -1,21 +1,25 @@ function Add-VSRoute53HostedZoneVPC { <# .SYNOPSIS - Adds an AWS::Route53::HostedZone.VPC resource property to the template. + Adds an AWS::Route53::HostedZone.VPC resource property to the template. (Private hosted zones only A complex type that contains information about an Amazon VPC. .DESCRIPTION Adds an AWS::Route53::HostedZone.VPC resource property to the template. - +(Private hosted zones only A complex type that contains information about an Amazon VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html .PARAMETER VPCId + Private hosted zones only The ID of an Amazon VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcid PrimitiveType: String UpdateType: Mutable .PARAMETER VPCRegion + Private hosted zones only The region that an Amazon VPC was created in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcregion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 index 0993993e4..7dcd7d28e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 @@ -1,26 +1,115 @@ function Add-VSRoute53RecordSetAliasTarget { <# .SYNOPSIS - Adds an AWS::Route53::RecordSet.AliasTarget resource property to the template. + Adds an AWS::Route53::RecordSet.AliasTarget resource property to the template. *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. .DESCRIPTION Adds an AWS::Route53::RecordSet.AliasTarget resource property to the template. +*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. +When creating resource record sets for a private hosted zone, note the following: + ++ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. + ++ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html .PARAMETER DNSName + *Alias resource record sets only:* The value that you specify depends on where you want to route queries: +Amazon API Gateway custom regional APIs and edge-optimized APIs +Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html: ++ For regional APIs, specify the value of regionalDomainName. ++ For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net. +The name of the record that you're creating must match a custom domain name for your API, such as api.example.com. +Amazon Virtual Private Cloud interface VPC endpoint +Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. +CloudFront distribution +Specify the domain name that CloudFront assigned when you created your distribution. +Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names CNAMEs: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html in the *Amazon CloudFront Developer Guide*. +You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. +For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. +Elastic Beanstalk environment +If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name. +For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. +For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute: ++ *AWS Management Console*: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html in the *AWS Elastic Beanstalk Developer Guide*. ++ *Elastic Beanstalk API*: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments: http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html in the *AWS Elastic Beanstalk API Reference*. ++ *AWS CLI*: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html in the *AWS Command Line Interface Reference*. +ELB load balancer +Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. ++ **AWS Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. +If you're routing traffic to a Classic Load Balancer, get the value that begins with **dualstack**. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html ++ Application and Network Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ++ **AWS CLI**: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html ++ Application and Network Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html +Amazon S3 bucket that is configured as a static website +Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service S3 Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html in the *Amazon Route 53 Developer Guide.* +Another Route 53 resource record set +Specify the value of the Name element for a resource record set in the current hosted zone. +If you're creating an alias record that has the same name as the hosted zone known as the zone apex, you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname PrimitiveType: String UpdateType: Mutable .PARAMETER EvaluateTargetHealth + *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone. +Note the following: +CloudFront distributions +You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution. +Elastic Beanstalk environments that have regionalized subdomains +If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance. If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. +If the environment contains a single Amazon EC2 instance, there are no special requirements. +ELB load balancers +Health checking behavior depends on the type of load balancer: ++ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. ++ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: ++ For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. ++ A target group that has no registered targets is considered unhealthy. +When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. +S3 buckets +There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket. +Other records in the same hosted zone +If the AWS resource that you specify in DNSName is a record or a group of records for example, a group of weighted records but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks?: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting in the *Amazon Route 53 Developer Guide*. +For more information and examples, see Amazon Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HostedZoneId + *Alias resource records sets only*: The value used depends on where you want to route traffic: +Amazon API Gateway custom regional APIs and edge-optimized APIs +Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html: ++ For regional APIs, specify the value of regionalHostedZoneId. ++ For edge-optimized APIs, specify the value of distributionHostedZoneId. +Amazon Virtual Private Cloud interface VPC endpoint +Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. +CloudFront distribution +Specify Z2FDTNDATAQYW2. +Alias resource record sets for CloudFront can't be created in a private zone. +Elastic Beanstalk environment +Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk: http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. +ELB load balancer +Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: ++ Elastic Load Balancing: https://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. ++ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneId. ++ **AWS CLI**: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html to get the value of CanonicalHostedZoneId. +An Amazon S3 bucket configured as a static website +Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. +Another Route 53 resource record set in your hosted zone +Specify the hosted zone ID of your hosted zone. An alias resource record set can't reference a resource record set in a different hosted zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 index 153204480..32f5b5ece 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 @@ -1,26 +1,34 @@ function Add-VSRoute53RecordSetGeoLocation { <# .SYNOPSIS - Adds an AWS::Route53::RecordSet.GeoLocation resource property to the template. + Adds an AWS::Route53::RecordSet.GeoLocation resource property to the template. A complex type that contains information about a geographic location. .DESCRIPTION Adds an AWS::Route53::RecordSet.GeoLocation resource property to the template. - +A complex type that contains information about a geographic location. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html .PARAMETER ContinentCode + The two-letter code for the continent. +Valid values: AF | AN | AS | EU | OC | NA | SA +Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode PrimitiveType: String UpdateType: Mutable .PARAMETER CountryCode + The two-letter code for the country. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode PrimitiveType: String UpdateType: Mutable .PARAMETER SubdivisionCode + The code for the subdivision. Route 53 currently supports only states in the United States. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 index f1e3f9b5b..fa2b2a95b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 @@ -1,26 +1,115 @@ function Add-VSRoute53RecordSetGroupAliasTarget { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup.AliasTarget resource property to the template. + Adds an AWS::Route53::RecordSetGroup.AliasTarget resource property to the template. *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. .DESCRIPTION Adds an AWS::Route53::RecordSetGroup.AliasTarget resource property to the template. +*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. +When creating resource record sets for a private hosted zone, note the following: + ++ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. + ++ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html .PARAMETER DNSName + *Alias resource record sets only:* The value that you specify depends on where you want to route queries: +Amazon API Gateway custom regional APIs and edge-optimized APIs +Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html: ++ For regional APIs, specify the value of regionalDomainName. ++ For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net. +The name of the record that you're creating must match a custom domain name for your API, such as api.example.com. +Amazon Virtual Private Cloud interface VPC endpoint +Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. +CloudFront distribution +Specify the domain name that CloudFront assigned when you created your distribution. +Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names CNAMEs: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html in the *Amazon CloudFront Developer Guide*. +You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. +For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. +Elastic Beanstalk environment +If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name. +For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. +For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute: ++ *AWS Management Console*: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html in the *AWS Elastic Beanstalk Developer Guide*. ++ *Elastic Beanstalk API*: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments: http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html in the *AWS Elastic Beanstalk API Reference*. ++ *AWS CLI*: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html in the *AWS Command Line Interface Reference*. +ELB load balancer +Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. ++ **AWS Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. +If you're routing traffic to a Classic Load Balancer, get the value that begins with **dualstack**. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html ++ Application and Network Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ++ **AWS CLI**: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html ++ Application and Network Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html +Amazon S3 bucket that is configured as a static website +Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service S3 Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html in the *Amazon Route 53 Developer Guide.* +Another Route 53 resource record set +Specify the value of the Name element for a resource record set in the current hosted zone. +If you're creating an alias record that has the same name as the hosted zone known as the zone apex, you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname PrimitiveType: String UpdateType: Mutable .PARAMETER EvaluateTargetHealth + *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone. +Note the following: +CloudFront distributions +You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution. +Elastic Beanstalk environments that have regionalized subdomains +If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance. If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. +If the environment contains a single Amazon EC2 instance, there are no special requirements. +ELB load balancers +Health checking behavior depends on the type of load balancer: ++ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. ++ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: ++ For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. ++ A target group that has no registered targets is considered unhealthy. +When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. +S3 buckets +There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket. +Other records in the same hosted zone +If the AWS resource that you specify in DNSName is a record or a group of records for example, a group of weighted records but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks?: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting in the *Amazon Route 53 Developer Guide*. +For more information and examples, see Amazon Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HostedZoneId + *Alias resource records sets only*: The value used depends on where you want to route traffic: +Amazon API Gateway custom regional APIs and edge-optimized APIs +Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html: ++ For regional APIs, specify the value of regionalHostedZoneId. ++ For edge-optimized APIs, specify the value of distributionHostedZoneId. +Amazon Virtual Private Cloud interface VPC endpoint +Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. +CloudFront distribution +Specify Z2FDTNDATAQYW2. +Alias resource record sets for CloudFront can't be created in a private zone. +Elastic Beanstalk environment +Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk: http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. +ELB load balancer +Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: ++ Elastic Load Balancing: https://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. ++ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneId. ++ **AWS CLI**: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html to get the value of CanonicalHostedZoneId. +An Amazon S3 bucket configured as a static website +Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. +Another Route 53 resource record set in your hosted zone +Specify the hosted zone ID of your hosted zone. An alias resource record set can't reference a resource record set in a different hosted zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 index ba0e2ffeb..b4727ea97 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 @@ -1,26 +1,34 @@ function Add-VSRoute53RecordSetGroupGeoLocation { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup.GeoLocation resource property to the template. + Adds an AWS::Route53::RecordSetGroup.GeoLocation resource property to the template. A complex type that contains information about a geographic location. .DESCRIPTION Adds an AWS::Route53::RecordSetGroup.GeoLocation resource property to the template. - +A complex type that contains information about a geographic location. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html .PARAMETER ContinentCode + The two-letter code for the continent. +Valid values: AF | AN | AS | EU | OC | NA | SA +Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode PrimitiveType: String UpdateType: Mutable .PARAMETER CountryCode + The two-letter code for the country. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode PrimitiveType: String UpdateType: Mutable .PARAMETER SubdivisionCode + The code for the subdivision. Route 53 currently supports only states in the United States. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 index 76c321431..378a8b875 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 @@ -1,66 +1,169 @@ function Add-VSRoute53RecordSetGroupRecordSet { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup.RecordSet resource property to the template. + Adds an AWS::Route53::RecordSetGroup.RecordSet resource property to the template. Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. .DESCRIPTION Adds an AWS::Route53::RecordSetGroup.RecordSet resource property to the template. +Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. +For more information, see ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html in the *Amazon Route 53 API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html .PARAMETER AliasTarget + *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. +If you're creating resource records sets for a private hosted zone, note the following: ++ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. ++ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. ++ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget Type: AliasTarget UpdateType: Mutable .PARAMETER Comment + *Optional:* Any comments you want to include about a change batch request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment PrimitiveType: String UpdateType: Mutable .PARAMETER Failover + *Failover resource record sets only:* To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set. +Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets: ++ When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set. ++ When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set. ++ When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set. ++ If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint. +You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets. +For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true. +For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: ++ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover PrimitiveType: String UpdateType: Mutable .PARAMETER GeoLocation + *Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF. +Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported. +If you create separate resource record sets for overlapping geographic regions for example, one resource record set for a continent and one for a country on the same continent, priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. +You can't create two geolocation resource record sets that specify the same geographic location. +The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements. +Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. +You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation Type: GeoLocation UpdateType: Mutable .PARAMETER HealthCheckId + If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check. +Route 53 determines whether a resource record set is healthy based on one of the following: ++ By periodically sending a request to the endpoint that is specified in the health check ++ By aggregating the status of a specified group of health checks calculated health checks ++ By determining the current state of a CloudWatch alarm CloudWatch metric health checks +Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. +For more information, see the following topics in the *Amazon Route 53 Developer Guide*: ++ How Amazon Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html ++ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html +**When to Specify HealthCheckId** +Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: ++ **Non-alias resource record sets**: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type such as multiple weighted records named www.example.com with a type of A and you specify health check IDs for all the resource record sets. +If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. +If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. +If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. ++ **Alias resource record sets**: You specify the following settings: ++ You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type such as multiple weighted records named www.example.com with a type of A. ++ You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone. ++ You specify a health check ID for the non-alias resource record set. +If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with. +If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set. +**Note** +The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets. +**Geolocation Routing** +For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy: ++ The United States ++ North America ++ The default resource record set +**Specifying the Health Check Endpoint by Domain Name** +If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server such as us-east-2-www.example.com, not the name of the resource record sets www.example.com. +Health check results will be unpredictable if you do the following: ++ Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set. ++ Associate that health check with the resource record set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid PrimitiveType: String UpdateType: Mutable .PARAMETER HostedZoneId + The ID of the hosted zone that contains the resource record sets that you want to change. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid PrimitiveType: String UpdateType: Mutable .PARAMETER HostedZoneName + The name of the domain for the hosted zone where you want to add the resource record set. +When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. +If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using HostedZoneId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename PrimitiveType: String UpdateType: Mutable .PARAMETER MultiValueAnswer + *Multivalue answer resource record sets only*: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following: ++ If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy. ++ If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy. ++ Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records. ++ If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records. ++ When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records. ++ If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response. +You can't create multivalue answer alias records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. +**ChangeResourceRecordSets Only** +Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com without a trailing dot and www.example.com. with a trailing dot as identical. +For information about how to specify characters other than a-z, 0-9, and - hyphen and how to specify internationalized domain names, see DNS Domain Name Format: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html in the *Amazon Route 53 Developer Guide*. +You can use the asterisk * wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following: ++ The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com. ++ The * can't replace any of the middle labels, for example, marketing.*.example.com. ++ If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character ASCII 42, not as a wildcard. +**Important** +You can't use the * wildcard for resource records sets that have a type of NS. +You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name PrimitiveType: String UpdateType: Mutable .PARAMETER Region + *Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. +Creating latency and latency alias resource record sets in private hosted zones is not supported. +When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. +Note the following: ++ You can only specify one ResourceRecord per latency resource record set. ++ You can only create one latency resource record set for each Amazon EC2 Region. ++ You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for. ++ You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceRecords + Information about the resource record sets that you want to add to the hosted zone. Each record should be in the format appropriate for the record type specified by the Type property. For information about different record types and their record formats, see Values That You Specify When You Create or Edit Amazon Route 53 Records: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords DuplicatesAllowed: False PrimitiveItemType: String @@ -68,21 +171,55 @@ function Add-VSRoute53RecordSetGroupRecordSet { UpdateType: Mutable .PARAMETER SetIdentifier + *Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set. +For information about routing policies, see Choosing a Routing Policy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER TTL + The resource record cache time to live TTL, in seconds. Note the following: ++ If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target. ++ If you're associating this resource record set with a health check if you're adding a HealthCheckId element, we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status. ++ All of the resource record sets in a group of weighted resource record sets must have the same value for TTL. ++ If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds the TTL for load balancers will change the effect of the values that you specify for Weight. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. +Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT +Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. +Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT +SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, *Sender Policy Framework SPF for Authorizing Use of Domains in Email, Version 1*, has been updated to say, "...I]ts existence and mechanism defined in RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type: http://tools.ietf.org/html/rfc7208#section-14.1. +Values for alias resource record sets: ++ **Amazon API Gateway custom regional APIs and edge-optimized APIs:** A ++ **CloudFront distributions:** A +If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA. ++ **AWS Elastic Beanstalk environment that has a regionalized subdomain**: A ++ **ELB load balancers:** A | AAAA ++ **Amazon S3 buckets:** A ++ **Amazon Virtual Private Cloud interface VPC endpoints** A ++ **Another resource record set in this hosted zone:** Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA. +**Note** +If you're creating an alias record that has the same name as the hosted zone known as the zone apex, you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type PrimitiveType: String UpdateType: Mutable .PARAMETER Weight + *Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following: ++ You must specify a value for the Weight element for every weighted resource record set. ++ You can only specify one ResourceRecord per weighted resource record set. ++ You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets. ++ You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements. ++ For weighted but not weighted alias resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. +The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverEndpointIpAddressRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverEndpointIpAddressRequest.ps1 index ed4942940..7ab86866e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverEndpointIpAddressRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverEndpointIpAddressRequest.ps1 @@ -1,21 +1,25 @@ function Add-VSRoute53ResolverResolverEndpointIpAddressRequest { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest resource property to the template. + Adds an AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest resource property to the template. In a CreateResolverEndpoint: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html request, the IP address that DNS queries originate from (for outbound endpoints or that you forward DNS queries to (for inbound endpoints. IpAddressRequest also includes the ID of the subnet that contains the IP address. .DESCRIPTION Adds an AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest resource property to the template. - +In a CreateResolverEndpoint: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html request, the IP address that DNS queries originate from (for outbound endpoints or that you forward DNS queries to (for inbound endpoints. IpAddressRequest also includes the ID of the subnet that contains the IP address. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html .PARAMETER Ip + The IP address that you want to use for DNS queries. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html#cfn-route53resolver-resolverendpoint-ipaddressrequest-ip PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet that contains the IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html#cfn-route53resolver-resolverendpoint-ipaddressrequest-subnetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverRuleTargetAddress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverRuleTargetAddress.ps1 index 932d53403..3f4d2b17b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverRuleTargetAddress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53ResolverResolverRuleTargetAddress.ps1 @@ -1,21 +1,25 @@ function Add-VSRoute53ResolverResolverRuleTargetAddress { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverRule.TargetAddress resource property to the template. + Adds an AWS::Route53Resolver::ResolverRule.TargetAddress resource property to the template. In a CreateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html request, an array of the IPs that you want to forward DNS queries to. .DESCRIPTION Adds an AWS::Route53Resolver::ResolverRule.TargetAddress resource property to the template. - +In a CreateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html request, an array of the IPs that you want to forward DNS queries to. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html .PARAMETER Ip + One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-ip PrimitiveType: String UpdateType: Mutable .PARAMETER Port + The port at Ip that you want to forward DNS queries to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-port PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAbortIncompleteMultipartUpload.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAbortIncompleteMultipartUpload.ps1 index ccc26ac58..d3e8576fb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAbortIncompleteMultipartUpload.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAbortIncompleteMultipartUpload.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketAbortIncompleteMultipartUpload { <# .SYNOPSIS - Adds an AWS::S3::Bucket.AbortIncompleteMultipartUpload resource property to the template. + Adds an AWS::S3::Bucket.AbortIncompleteMultipartUpload resource property to the template. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.AbortIncompleteMultipartUpload resource property to the template. - +Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html .PARAMETER DaysAfterInitiation + Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html#cfn-s3-bucket-abortincompletemultipartupload-daysafterinitiation PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccelerateConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccelerateConfiguration.ps1 index 4e9809941..155863e7e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccelerateConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccelerateConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketAccelerateConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.AccelerateConfiguration resource property to the template. + Adds an AWS::S3::Bucket.AccelerateConfiguration resource property to the template. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.AccelerateConfiguration resource property to the template. - +Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html .PARAMETER AccelerationStatus + Specifies the transfer acceleration status of the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html#cfn-s3-bucket-accelerateconfiguration-accelerationstatus PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccessControlTranslation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccessControlTranslation.ps1 index 07de9357b..6fb2ecdbd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccessControlTranslation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAccessControlTranslation.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketAccessControlTranslation { <# .SYNOPSIS - Adds an AWS::S3::Bucket.AccessControlTranslation resource property to the template. + Adds an AWS::S3::Bucket.AccessControlTranslation resource property to the template. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same, and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object. .DESCRIPTION Adds an AWS::S3::Bucket.AccessControlTranslation resource property to the template. - +Specify this only in a cross-account scenario (where source and destination bucket owners are not the same, and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html .PARAMETER Owner + Specifies the replica ownership. For default and valid values, see PUT bucket replication: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html in the *Amazon Simple Storage Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html#cfn-s3-bucket-accesscontroltranslation-owner PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 index cb4912fbf..7bffebb64 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 @@ -1,31 +1,42 @@ function Add-VSS3BucketAnalyticsConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.AnalyticsConfiguration resource property to the template. + Adds an AWS::S3::Bucket.AnalyticsConfiguration resource property to the template. Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.AnalyticsConfiguration resource property to the template. +Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. +For more information, see GET Bucket analytics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETAnalyticsConfig.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html .PARAMETER Id + The ID that identifies the analytics configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + The prefix that an object must have to be included in the analytics results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER StorageClassAnalysis + Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-storageclassanalysis Type: StorageClassAnalysis UpdateType: Mutable .PARAMETER TagFilters + The tags to use when evaluating an analytics filter. +The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters DuplicatesAllowed: False ItemType: TagFilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketBucketEncryption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketBucketEncryption.ps1 index 7d00d3eca..3317aab88 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketBucketEncryption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketBucketEncryption.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketBucketEncryption { <# .SYNOPSIS - Adds an AWS::S3::Bucket.BucketEncryption resource property to the template. + Adds an AWS::S3::Bucket.BucketEncryption resource property to the template. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3 or AWS KMS-managed keys (SSE-KMS bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.BucketEncryption resource property to the template. - +Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3 or AWS KMS-managed keys (SSE-KMS bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html .PARAMETER ServerSideEncryptionConfiguration + Specifies the default server-side-encryption configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html#cfn-s3-bucket-bucketencryption-serversideencryptionconfiguration DuplicatesAllowed: False ItemType: ServerSideEncryptionRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 index f836c21a5..4c866a4dd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketCorsConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.CorsConfiguration resource property to the template. + Adds an AWS::S3::Bucket.CorsConfiguration resource property to the template. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.CorsConfiguration resource property to the template. - +Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html .PARAMETER CorsRules + A set of allowed origins and methods. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html#cfn-s3-bucket-cors-corsrule DuplicatesAllowed: False ItemType: CorsRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsRule.ps1 index fbb50cf08..d8b2486f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsRule.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketCorsRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.CorsRule resource property to the template. + Adds an AWS::S3::Bucket.CorsRule resource property to the template. Specifies a cross-origin access rule for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.CorsRule resource property to the template. - +Specifies a cross-origin access rule for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html .PARAMETER AllowedHeaders + Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedheaders DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +20,8 @@ function Add-VSS3BucketCorsRule { UpdateType: Mutable .PARAMETER AllowedMethods + An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedmethods DuplicatesAllowed: False PrimitiveItemType: String @@ -25,6 +29,8 @@ function Add-VSS3BucketCorsRule { UpdateType: Mutable .PARAMETER AllowedOrigins + One or more origins you want customers to be able to access the bucket from. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedorigins DuplicatesAllowed: False PrimitiveItemType: String @@ -32,6 +38,8 @@ function Add-VSS3BucketCorsRule { UpdateType: Mutable .PARAMETER ExposedHeaders + One or more headers in the response that you want customers to be able to access from their applications for example, from a JavaScript XMLHttpRequest object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-exposedheaders DuplicatesAllowed: False PrimitiveItemType: String @@ -39,11 +47,15 @@ function Add-VSS3BucketCorsRule { UpdateType: Mutable .PARAMETER Id + A unique identifier for this rule. The value must be no more than 255 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-id PrimitiveType: String UpdateType: Mutable .PARAMETER MaxAge + The time in seconds that your browser is to cache the preflight response for the specified resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-maxage PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDataExport.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDataExport.ps1 index ee2419e16..a2d5c27c8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDataExport.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDataExport.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketDataExport { <# .SYNOPSIS - Adds an AWS::S3::Bucket.DataExport resource property to the template. + Adds an AWS::S3::Bucket.DataExport resource property to the template. Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. .DESCRIPTION Adds an AWS::S3::Bucket.DataExport resource property to the template. - +Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html .PARAMETER Destination + The place to store the data for an analysis. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-destination Type: Destination UpdateType: Mutable .PARAMETER OutputSchemaVersion + The version of the output schema to use when exporting data. Must be V_1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-outputschemaversion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 index 433b7e28e..73140872b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 @@ -1,26 +1,32 @@ function Add-VSS3BucketDefaultRetention { <# .SYNOPSIS - Adds an AWS::S3::Bucket.DefaultRetention resource property to the template. + Adds an AWS::S3::Bucket.DefaultRetention resource property to the template. The default retention period that you want to apply to new objects placed in the specified bucket. .DESCRIPTION Adds an AWS::S3::Bucket.DefaultRetention resource property to the template. - +The default retention period that you want to apply to new objects placed in the specified bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html .PARAMETER Days + The number of days that you want to specify for the default retention period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-days PrimitiveType: Integer UpdateType: Mutable .PARAMETER Mode + The default object lock retention mode you want to apply to new objects placed in the specified bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-mode PrimitiveType: String UpdateType: Mutable .PARAMETER Years + The number of years that you want to specify for the default retention period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-years PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 index 12a9f5685..2e5219277 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 @@ -1,31 +1,39 @@ function Add-VSS3BucketDestination { <# .SYNOPSIS - Adds an AWS::S3::Bucket.Destination resource property to the template. + Adds an AWS::S3::Bucket.Destination resource property to the template. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.Destination resource property to the template. - +Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html .PARAMETER BucketAccountId + The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid PrimitiveType: String UpdateType: Mutable .PARAMETER BucketArn + The Amazon Resource Name ARN of the bucket to which data is exported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER Format + Specifies the file format used when exporting data to Amazon S3. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + The prefix to use when exporting data. The prefix is prepended to all results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 index 0f02ae24e..de77b3636 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketEncryptionConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.EncryptionConfiguration resource property to the template. + Adds an AWS::S3::Bucket.EncryptionConfiguration resource property to the template. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. .DESCRIPTION Adds an AWS::S3::Bucket.EncryptionConfiguration resource property to the template. - +Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html .PARAMETER ReplicaKmsKeyID + Specifies the AWS KMS Key ID Key ARN or Alias ARN for the destination bucket. Amazon S3 uses this key to encrypt replica objects. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html#cfn-s3-bucket-encryptionconfiguration-replicakmskeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketFilterRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketFilterRule.ps1 index 413c7c219..15061aafc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketFilterRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketFilterRule.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketFilterRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.FilterRule resource property to the template. + Adds an AWS::S3::Bucket.FilterRule resource property to the template. Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name. .DESCRIPTION Adds an AWS::S3::Bucket.FilterRule resource property to the template. - +Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html .PARAMETER Name + The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value that the filter searches for in object key names. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 index 3450d9f72..7c6872a57 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 @@ -1,36 +1,46 @@ function Add-VSS3BucketInventoryConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.InventoryConfiguration resource property to the template. + Adds an AWS::S3::Bucket.InventoryConfiguration resource property to the template. Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.InventoryConfiguration resource property to the template. - +Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html .PARAMETER Destination + Contains information about where to publish the inventory results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-destination Type: Destination UpdateType: Mutable .PARAMETER Enabled + Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Id + The ID used to identify the inventory configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER IncludedObjectVersions + Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-includedobjectversions PrimitiveType: String UpdateType: Mutable .PARAMETER OptionalFields + Contains the optional fields that are included in the inventory results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields DuplicatesAllowed: False PrimitiveItemType: String @@ -38,11 +48,15 @@ function Add-VSS3BucketInventoryConfiguration { UpdateType: Mutable .PARAMETER Prefix + The prefix that is prepended to all inventory results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduleFrequency + Specifies the schedule for generating inventory results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketLambdaConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketLambdaConfiguration.ps1 index fec3e70cf..27de5d2ba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketLambdaConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketLambdaConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSS3BucketLambdaConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.LambdaConfiguration resource property to the template. + Adds an AWS::S3::Bucket.LambdaConfiguration resource property to the template. Describes the AWS Lambda functions to invoke and the events for which to invoke them. .DESCRIPTION Adds an AWS::S3::Bucket.LambdaConfiguration resource property to the template. - +Describes the AWS Lambda functions to invoke and the events for which to invoke them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html .PARAMETER Event + The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see Supported Event Types: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event PrimitiveType: String UpdateType: Mutable .PARAMETER Filter + The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a .jpg extension invoke the function when they are added to the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-filter Type: NotificationFilter UpdateType: Mutable .PARAMETER Function + The Amazon Resource Name ARN of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-function PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketLifecycleConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketLifecycleConfiguration.ps1 index 26c165e54..3203cb492 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketLifecycleConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketLifecycleConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketLifecycleConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.LifecycleConfiguration resource property to the template. + Adds an AWS::S3::Bucket.LifecycleConfiguration resource property to the template. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.LifecycleConfiguration resource property to the template. - +Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html .PARAMETER Rules + A lifecycle rule for individual objects in an Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html#cfn-s3-bucket-lifecycleconfig-rules DuplicatesAllowed: False ItemType: Rule diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketLoggingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketLoggingConfiguration.ps1 index e6ce22e7d..10f1d9255 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketLoggingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketLoggingConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketLoggingConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.LoggingConfiguration resource property to the template. + Adds an AWS::S3::Bucket.LoggingConfiguration resource property to the template. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.LoggingConfiguration resource property to the template. - +Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html .PARAMETER DestinationBucketName + The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-destinationbucketname PrimitiveType: String UpdateType: Mutable .PARAMETER LogFilePrefix + A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-logfileprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketMetricsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketMetricsConfiguration.ps1 index d543f4ad5..18c2aa928 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketMetricsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketMetricsConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSS3BucketMetricsConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.MetricsConfiguration resource property to the template. + Adds an AWS::S3::Bucket.MetricsConfiguration resource property to the template. Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.MetricsConfiguration resource property to the template. - +Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html .PARAMETER Id + The ID used to identify the metrics configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + The prefix that an object must have to be included in the metrics results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters + Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-tagfilters DuplicatesAllowed: False ItemType: TagFilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 index fa94d9c23..303561661 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketNoncurrentVersionTransition { <# .SYNOPSIS - Adds an AWS::S3::Bucket.NoncurrentVersionTransition resource property to the template. + Adds an AWS::S3::Bucket.NoncurrentVersionTransition resource property to the template. Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended, you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime. .DESCRIPTION Adds an AWS::S3::Bucket.NoncurrentVersionTransition resource property to the template. - +Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended, you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html .PARAMETER StorageClass + The class of storage used to store the object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-storageclass PrimitiveType: String UpdateType: Mutable .PARAMETER TransitionInDays + Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-transitionindays PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 index 4afb2a39f..13825d56b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 @@ -1,16 +1,26 @@ function Add-VSS3BucketNotificationConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.NotificationConfiguration resource property to the template. + Adds an AWS::S3::Bucket.NotificationConfiguration resource property to the template. Describes the notification configuration for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.NotificationConfiguration resource property to the template. +Describes the notification configuration for an Amazon S3 bucket. +**Note** + +If you create the target resource and related permissions in the same template, you might have a circular dependency. + +For example, you might use the AWS::Lambda::Permission resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function. If you're using Refs to pass the bucket name, this leads to a circular dependency. + +To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html .PARAMETER LambdaConfigurations + Describes the AWS Lambda functions to invoke and the events for which to invoke them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig DuplicatesAllowed: False ItemType: LambdaConfiguration @@ -18,6 +28,8 @@ function Add-VSS3BucketNotificationConfiguration { UpdateType: Mutable .PARAMETER QueueConfigurations + The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-queueconfig DuplicatesAllowed: False ItemType: QueueConfiguration @@ -25,6 +37,8 @@ function Add-VSS3BucketNotificationConfiguration { UpdateType: Mutable .PARAMETER TopicConfigurations + The topic to which notifications are sent and the events for which notifications are generated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-topicconfig DuplicatesAllowed: False ItemType: TopicConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationFilter.ps1 index 642d28f7b..a7f27e17b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationFilter.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketNotificationFilter { <# .SYNOPSIS - Adds an AWS::S3::Bucket.NotificationFilter resource property to the template. + Adds an AWS::S3::Bucket.NotificationFilter resource property to the template. Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.NotificationFilter resource property to the template. - +Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html .PARAMETER S3Key + A container for object key name prefix and suffix filtering rules. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key Type: S3KeyFilter UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 index 6ce44815a..efdda0ba7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketObjectLockConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. + Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket. .DESCRIPTION Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. - +Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html .PARAMETER ObjectLockEnabled + Indicates whether this bucket has an object lock configuration enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-objectlockenabled PrimitiveType: String UpdateType: Mutable .PARAMETER Rule + The object lock rule in place for the specified object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-rule Type: ObjectLockRule UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 index ce08e5c2e..15c14387e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketObjectLockRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. + Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. The object lock rule in place for the specified object. .DESCRIPTION Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. - +The object lock rule in place for the specified object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html .PARAMETER DefaultRetention + The default retention period that you want to apply to new objects placed in the specified bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html#cfn-s3-bucket-objectlockrule-defaultretention Type: DefaultRetention UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 index 8ca9bdfc0..6bf6240f7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 @@ -1,31 +1,45 @@ function Add-VSS3BucketPublicAccessBlockConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. + Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. Specifies the Block Public Access configuration for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. - +Specifies the Block Public Access configuration for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html .PARAMETER BlockPublicAcls + Specifies whether Amazon S3 should block public access control lists ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: ++ PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. ++ PUT Object calls fail if the request includes a public ACL. +Enabling this setting doesn't affect existing policies or ACLs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicacls PrimitiveType: Boolean UpdateType: Mutable .PARAMETER BlockPublicPolicy + Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. +Enabling this setting doesn't affect existing bucket policies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicpolicy PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IgnorePublicAcls + Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. +Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-ignorepublicacls PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RestrictPublicBuckets + Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. +Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-restrictpublicbuckets PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketQueueConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketQueueConfiguration.ps1 index 5b9b0a776..9ee193497 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketQueueConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketQueueConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSS3BucketQueueConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.QueueConfiguration resource property to the template. + Adds an AWS::S3::Bucket.QueueConfiguration resource property to the template. Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS queue when Amazon S3 detects specified events. .DESCRIPTION Adds an AWS::S3::Bucket.QueueConfiguration resource property to the template. - +Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS queue when Amazon S3 detects specified events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html .PARAMETER Event + The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see Supported Event Types: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-event PrimitiveType: String UpdateType: Mutable .PARAMETER Filter + The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a .jpg extension are added to the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-filter Type: NotificationFilter UpdateType: Mutable .PARAMETER Queue + The Amazon Resource Name ARN of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-queue PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectAllRequestsTo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectAllRequestsTo.ps1 index dce1eaf62..57c789f53 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectAllRequestsTo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectAllRequestsTo.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketRedirectAllRequestsTo { <# .SYNOPSIS - Adds an AWS::S3::Bucket.RedirectAllRequestsTo resource property to the template. + Adds an AWS::S3::Bucket.RedirectAllRequestsTo resource property to the template. Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.RedirectAllRequestsTo resource property to the template. - +Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html .PARAMETER HostName + Name of the host where requests are redirected. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-hostname PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol + Protocol to use when redirecting requests. The default is the protocol that is used in the original request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-protocol PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectRule.ps1 index 700bf318d..d2f6155a2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRedirectRule.ps1 @@ -1,36 +1,46 @@ function Add-VSS3BucketRedirectRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.RedirectRule resource property to the template. + Adds an AWS::S3::Bucket.RedirectRule resource property to the template. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return. .DESCRIPTION Adds an AWS::S3::Bucket.RedirectRule resource property to the template. - +Specifies how requests are redirected. In the event of an error, you can specify a different error code to return. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html .PARAMETER HostName + The host name to use in the redirect request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-hostname PrimitiveType: String UpdateType: Mutable .PARAMETER HttpRedirectCode + The HTTP redirect code to use on the response. Not required if one of the siblings is present. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-httpredirectcode PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol + Protocol to use when redirecting requests. The default is the protocol that is used in the original request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER ReplaceKeyPrefixWith + The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ objects in the docs/ folder to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeyprefixwith PrimitiveType: String UpdateType: Mutable .PARAMETER ReplaceKeyWith + The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeywith PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 index a44c0bb02..00b582b3b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketReplicationConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ReplicationConfiguration resource property to the template. + Adds an AWS::S3::Bucket.ReplicationConfiguration resource property to the template. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationConfiguration resource property to the template. - +A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html .PARAMETER Role + The Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Cross-Region Replication: https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-how-setup.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-role PrimitiveType: String UpdateType: Mutable .PARAMETER Rules + A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-rules DuplicatesAllowed: False ItemType: ReplicationRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 index 469fb0f00..917e2921c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 @@ -1,36 +1,49 @@ function Add-VSS3BucketReplicationDestination { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ReplicationDestination resource property to the template. + Adds an AWS::S3::Bucket.ReplicationDestination resource property to the template. Specifies which Amazon S3 bucket to store replicated objects in and their storage class. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationDestination resource property to the template. - +Specifies which Amazon S3 bucket to store replicated objects in and their storage class. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html .PARAMETER AccessControlTranslation + Specify this only in a cross-account scenario where source and destination bucket owners are not the same, and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-accesscontroltranslation Type: AccessControlTranslation UpdateType: Mutable .PARAMETER Account + Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Cross-Region Replication Additional Configuration: Change Replica Owner: https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html in the *Amazon Simple Storage Service Developer Guide*. +If you specify the AccessControlTranslation property, the Account property is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-account PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket + The Amazon Resource Name ARN of the bucket where you want Amazon S3 to store replicas of the object identified by the rule. +A replication configuration can replicate objects to only one destination bucket. If there are multiple rules in your replication configuration, all rules must specify the same destination bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionConfiguration + Specifies encryption-related information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-encryptionconfiguration Type: EncryptionConfiguration UpdateType: Mutable .PARAMETER StorageClass + The storage class to use when replicating objects, such as standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. +For valid values, see the StorageClass element of the PUT Bucket replication: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html action in the *Amazon Simple Storage Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-storageclass PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 index fb439df6e..f489fbeed 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 @@ -1,36 +1,46 @@ function Add-VSS3BucketReplicationRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ReplicationRule resource property to the template. + Adds an AWS::S3::Bucket.ReplicationRule resource property to the template. Specifies which Amazon S3 objects to replicate and where to store the replicas. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationRule resource property to the template. - +Specifies which Amazon S3 objects to replicate and where to store the replicas. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html .PARAMETER Destination + A container for information about the replication destination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-destination Type: ReplicationDestination UpdateType: Mutable .PARAMETER Id + A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER SourceSelectionCriteria + A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key SSE-KMS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-sourceselectioncriteria Type: SourceSelectionCriteria UpdateType: Mutable .PARAMETER Status + Specifies whether the rule is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-status PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRule.ps1 index 0d15e696a..a55f4f001 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRule.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketRoutingRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.RoutingRule resource property to the template. + Adds an AWS::S3::Bucket.RoutingRule resource property to the template. Specifies the redirect behavior and when a redirect is applied. .DESCRIPTION Adds an AWS::S3::Bucket.RoutingRule resource property to the template. - +Specifies the redirect behavior and when a redirect is applied. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html .PARAMETER RedirectRule + Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-redirectrule Type: RedirectRule UpdateType: Mutable .PARAMETER RoutingRuleCondition + A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition Type: RoutingRuleCondition UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 index ab6b79c8c..9af12fa6e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 @@ -1,21 +1,27 @@ function Add-VSS3BucketRoutingRuleCondition { <# .SYNOPSIS - Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. + Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. Specifies a condition that must be met for a redirect to apply. .DESCRIPTION Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. - +Specifies a condition that must be met for a redirect to apply. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html .PARAMETER HttpErrorCodeReturnedEquals + The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. +Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-httperrorcodereturnedequals PrimitiveType: String UpdateType: Mutable .PARAMETER KeyPrefixEquals + The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. +Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-keyprefixequals PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 index 5bce0bc76..0bbdd642a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 @@ -1,46 +1,66 @@ function Add-VSS3BucketRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.Rule resource property to the template. + Adds an AWS::S3::Bucket.Rule resource property to the template. Specifies lifecycle rules for an Amazon S3 bucket. For more information, see PUT Bucket lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.Rule resource property to the template. - +Specifies lifecycle rules for an Amazon S3 bucket. For more information, see PUT Bucket lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html .PARAMETER AbortIncompleteMultipartUpload + Specifies a lifecycle rule that aborts incomplete multipart uploads to an Amazon S3 bucket. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-abortincompletemultipartupload Type: AbortIncompleteMultipartUpload UpdateType: Mutable .PARAMETER ExpirationDate + Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationdate PrimitiveType: Timestamp UpdateType: Mutable .PARAMETER ExpirationInDays + Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationindays PrimitiveType: Integer UpdateType: Mutable .PARAMETER Id + Unique identifier for the rule. The value can't be longer than 255 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-id PrimitiveType: String UpdateType: Mutable .PARAMETER NoncurrentVersionExpirationInDays + For buckets with versioning enabled or suspended, specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversionexpirationindays PrimitiveType: Integer UpdateType: Mutable .PARAMETER NoncurrentVersionTransition + Deprecated. For buckets with versioning enabled or suspended, specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the NoncurrentVersionTransitions property. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition Type: NoncurrentVersionTransition UpdateType: Mutable .PARAMETER NoncurrentVersionTransitions + For buckets with versioning enabled or suspended, one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the NoncurrentVersionTransition property. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransitions DuplicatesAllowed: False ItemType: NoncurrentVersionTransition @@ -48,16 +68,22 @@ function Add-VSS3BucketRule { UpdateType: Mutable .PARAMETER Prefix + Object key prefix that identifies one or more objects to which this rule applies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Status + If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-status PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters + Tags to use to identify a subset of objects to which the lifecycle rule applies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-tagfilters DuplicatesAllowed: False ItemType: TagFilter @@ -65,11 +91,17 @@ function Add-VSS3BucketRule { UpdateType: Mutable .PARAMETER Transition + Deprecated. Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. If you specify this property, don't specify the Transitions property. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transition Type: Transition UpdateType: Mutable .PARAMETER Transitions + One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. If you specify this property, don't specify the Transition property. +You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transitions DuplicatesAllowed: False ItemType: Transition diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 index b0e6e3bdb..fa60fb3c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketS3KeyFilter { <# .SYNOPSIS - Adds an AWS::S3::Bucket.S3KeyFilter resource property to the template. + Adds an AWS::S3::Bucket.S3KeyFilter resource property to the template. A container for object key name prefix and suffix filtering rules. .DESCRIPTION Adds an AWS::S3::Bucket.S3KeyFilter resource property to the template. - +A container for object key name prefix and suffix filtering rules. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html .PARAMETER Rules + A list of containers for the key value pair that defines the criteria for the filter rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules DuplicatesAllowed: False ItemType: FilterRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 index 53d3e9a76..d91d2d527 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketServerSideEncryptionByDefault { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ServerSideEncryptionByDefault resource property to the template. + Adds an AWS::S3::Bucket.ServerSideEncryptionByDefault resource property to the template. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.ServerSideEncryptionByDefault resource property to the template. - +Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html .PARAMETER KMSMasterKeyID + KMS master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid PrimitiveType: String UpdateType: Mutable .PARAMETER SSEAlgorithm + Server-side encryption algorithm to use for the default encryption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-ssealgorithm PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionRule.ps1 index 1663be7d3..2963ce551 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionRule.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketServerSideEncryptionRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ServerSideEncryptionRule resource property to the template. + Adds an AWS::S3::Bucket.ServerSideEncryptionRule resource property to the template. Specifies the default server-side encryption configuration. .DESCRIPTION Adds an AWS::S3::Bucket.ServerSideEncryptionRule resource property to the template. - +Specifies the default server-side encryption configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html .PARAMETER ServerSideEncryptionByDefault + Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-serversideencryptionbydefault Type: ServerSideEncryptionByDefault UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 index 0f9dad9a2..3f76d78eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketSourceSelectionCriteria { <# .SYNOPSIS - Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. + Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS. .DESCRIPTION Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. - +A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html .PARAMETER SseKmsEncryptedObjects + A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-ssekmsencryptedobjects Type: SseKmsEncryptedObjects UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 index 2ee2e2bfe..3b5027f74 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketSseKmsEncryptedObjects { <# .SYNOPSIS - Adds an AWS::S3::Bucket.SseKmsEncryptedObjects resource property to the template. + Adds an AWS::S3::Bucket.SseKmsEncryptedObjects resource property to the template. A container for filter information for the selection of S3 objects encrypted with AWS KMS. .DESCRIPTION Adds an AWS::S3::Bucket.SseKmsEncryptedObjects resource property to the template. - +A container for filter information for the selection of S3 objects encrypted with AWS KMS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html .PARAMETER Status + Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS-managed key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html#cfn-s3-bucket-ssekmsencryptedobjects-status PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketStorageClassAnalysis.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketStorageClassAnalysis.ps1 index 62bda4a07..90e1eab75 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketStorageClassAnalysis.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketStorageClassAnalysis.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketStorageClassAnalysis { <# .SYNOPSIS - Adds an AWS::S3::Bucket.StorageClassAnalysis resource property to the template. + Adds an AWS::S3::Bucket.StorageClassAnalysis resource property to the template. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.StorageClassAnalysis resource property to the template. - +Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html .PARAMETER DataExport + Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html#cfn-s3-bucket-storageclassanalysis-dataexport Type: DataExport UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTagFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTagFilter.ps1 index 91aaee4b8..38a859136 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTagFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTagFilter.ps1 @@ -1,21 +1,25 @@ function Add-VSS3BucketTagFilter { <# .SYNOPSIS - Adds an AWS::S3::Bucket.TagFilter resource property to the template. + Adds an AWS::S3::Bucket.TagFilter resource property to the template. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.TagFilter resource property to the template. - +Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html .PARAMETER Key + The tag key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The tag value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTopicConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTopicConfiguration.ps1 index 919c3e7eb..99255c53a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTopicConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTopicConfiguration.ps1 @@ -1,26 +1,32 @@ function Add-VSS3BucketTopicConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.TopicConfiguration resource property to the template. + Adds an AWS::S3::Bucket.TopicConfiguration resource property to the template. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS topic when Amazon S3 detects specified events. .DESCRIPTION Adds an AWS::S3::Bucket.TopicConfiguration resource property to the template. - +A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS topic when Amazon S3 detects specified events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html .PARAMETER Event + The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-event PrimitiveType: String UpdateType: Mutable .PARAMETER Filter + The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a .jpg extension are added to the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-filter Type: NotificationFilter UpdateType: Mutable .PARAMETER Topic + The Amazon Resource Name ARN of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-topic PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 index f828e793f..f983825e1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 @@ -1,26 +1,32 @@ function Add-VSS3BucketTransition { <# .SYNOPSIS - Adds an AWS::S3::Bucket.Transition resource property to the template. + Adds an AWS::S3::Bucket.Transition resource property to the template. Specifies when an object transitions to a specified storage class. .DESCRIPTION Adds an AWS::S3::Bucket.Transition resource property to the template. - +Specifies when an object transitions to a specified storage class. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html .PARAMETER StorageClass + The storage class to which you want the object to transition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-storageclass PrimitiveType: String UpdateType: Mutable .PARAMETER TransitionDate + Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitiondate PrimitiveType: Timestamp UpdateType: Mutable .PARAMETER TransitionInDays + Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitionindays PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketVersioningConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketVersioningConfiguration.ps1 index 050db84c9..cbd9b5252 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketVersioningConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketVersioningConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSS3BucketVersioningConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.VersioningConfiguration resource property to the template. + Adds an AWS::S3::Bucket.VersioningConfiguration resource property to the template. Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.VersioningConfiguration resource property to the template. - +Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html .PARAMETER Status + The versioning state of the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html#cfn-s3-bucket-versioningconfig-status PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketWebsiteConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketWebsiteConfiguration.ps1 index 934f4b93f..1eaa90355 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketWebsiteConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketWebsiteConfiguration.ps1 @@ -1,31 +1,40 @@ function Add-VSS3BucketWebsiteConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.WebsiteConfiguration resource property to the template. + Adds an AWS::S3::Bucket.WebsiteConfiguration resource property to the template. Specifies website configuration parameters for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.WebsiteConfiguration resource property to the template. - +Specifies website configuration parameters for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html .PARAMETER ErrorDocument + The name of the error document for the website. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-errordocument PrimitiveType: String UpdateType: Mutable .PARAMETER IndexDocument + The name of the index document for the website. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-indexdocument PrimitiveType: String UpdateType: Mutable .PARAMETER RedirectAllRequestsTo + The redirect behavior for every request to this bucket's website endpoint. +If you specify this property, you can't specify any other property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-redirectallrequeststo Type: RedirectAllRequestsTo UpdateType: Mutable .PARAMETER RoutingRules + Rules that define when a redirect is applied and the redirect behavior. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-routingrules DuplicatesAllowed: False ItemType: RoutingRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationCloudWatchDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationCloudWatchDestination.ps1 index 6fb1d69d0..8774a658c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationCloudWatchDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationCloudWatchDestination.ps1 @@ -1,16 +1,20 @@ function Add-VSSESConfigurationSetEventDestinationCloudWatchDestination { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination resource property to the template. + Adds an AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination resource property to the template. Contains information associated with an Amazon CloudWatch event destination to which email sending events are published. .DESCRIPTION Adds an AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination resource property to the template. +Contains information associated with an Amazon CloudWatch event destination to which email sending events are published. +Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html .PARAMETER DimensionConfigurations + A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html#cfn-ses-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations ItemType: DimensionConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationDimensionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationDimensionConfiguration.ps1 index 11e3a0916..9e8ee4b06 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationDimensionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationDimensionConfiguration.ps1 @@ -1,26 +1,38 @@ function Add-VSSESConfigurationSetEventDestinationDimensionConfiguration { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration resource property to the template. + Adds an AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration resource property to the template. Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch. .DESCRIPTION Adds an AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration resource property to the template. +Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch. +For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/event-publishing-add-event-destination-cloudwatch.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html .PARAMETER DimensionValueSource + The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultDimensionValue + The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must: ++ Only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ Contain 256 or fewer characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue PrimitiveType: String UpdateType: Mutable .PARAMETER DimensionName + The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must: ++ Only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ Contain 256 or fewer characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 index d3d5e67bb..f33b77125 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 @@ -1,37 +1,55 @@ function Add-VSSESConfigurationSetEventDestinationEventDestination { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination.EventDestination resource property to the template. + Adds an AWS::SES::ConfigurationSetEventDestination.EventDestination resource property to the template. Contains information about the event destination that the specified email sending events are published to. .DESCRIPTION Adds an AWS::SES::ConfigurationSetEventDestination.EventDestination resource property to the template. +Contains information about the event destination that the specified email sending events are published to. +**Note** + +When you specify an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Data Firehose or Amazon Simple Notification Service (Amazon SNS. + +Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon Simple Notification Service (Amazon SNS. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html .PARAMETER CloudWatchDestination + An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination. + Type: CloudWatchDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination UpdateType: Mutable .PARAMETER Enabled + Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MatchingEventTypes + The type of email sending events to publish to the event destination. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes UpdateType: Mutable .PARAMETER Name + The name of the event destination. The name must: ++ This value can only contain ASCII letters a-z, A-Z, numbers 0-9, underscores _, or dashes -. ++ Contain less than 64 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-name PrimitiveType: String UpdateType: Mutable .PARAMETER KinesisFirehoseDestination + An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Data Firehose event destination. + Type: KinesisFirehoseDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-kinesisfirehosedestination UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 index 545c159dd..f79015d86 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationKinesisFirehoseDestination.ps1 @@ -1,21 +1,27 @@ function Add-VSSESConfigurationSetEventDestinationKinesisFirehoseDestination { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination resource property to the template. + Adds an AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination resource property to the template. Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Data Firehose event destination. .DESCRIPTION Adds an AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination resource property to the template. +Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Data Firehose event destination. +Event destinations, such as Amazon Kinesis Data Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html .PARAMETER IAMRoleARN + The ARN of the IAM role that Amazon SES uses to publish email sending events to the Amazon Kinesis Data Firehose stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-iamrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER DeliveryStreamARN + The ARN of the Amazon Kinesis Data Firehose stream that email sending events should be published to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-deliverystreamarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterFilter.ps1 index 6f8e02e6c..9aeabbcb0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterFilter.ps1 @@ -1,21 +1,28 @@ function Add-VSSESReceiptFilterFilter { <# .SYNOPSIS - Adds an AWS::SES::ReceiptFilter.Filter resource property to the template. + Adds an AWS::SES::ReceiptFilter.Filter resource property to the template. A data structure that describes the IP address filter that you want to specify. This structure consists of a name, an IP address range, and whether to allow or block mail from it. .DESCRIPTION Adds an AWS::SES::ReceiptFilter.Filter resource property to the template. - +A data structure that describes the IP address filter that you want to specify. This structure consists of a name, an IP address range, and whether to allow or block mail from it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html .PARAMETER IpFilter + A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them. + Type: IpFilter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-ipfilter UpdateType: Mutable .PARAMETER Name + The name of the IP address filter. The name must: ++ Only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ Start and end with a letter or number. ++ Contain 64 characters or fewer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterIpFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterIpFilter.ps1 index 54b5af593..aeab8e17b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterIpFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptFilterIpFilter.ps1 @@ -1,21 +1,27 @@ function Add-VSSESReceiptFilterIpFilter { <# .SYNOPSIS - Adds an AWS::SES::ReceiptFilter.IpFilter resource property to the template. + Adds an AWS::SES::ReceiptFilter.IpFilter resource property to the template. Receipt IP address filters enable you to specifically accept or reject incoming email that originates from an IP address or range of IP addresses. .DESCRIPTION Adds an AWS::SES::ReceiptFilter.IpFilter resource property to the template. +Receipt IP address filters enable you to specifically accept or reject incoming email that originates from an IP address or range of IP addresses. +For information about setting up IP address filters, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html .PARAMETER Policy + Indicates whether to block or allow incoming mail from the specified IP addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-policy PrimitiveType: String UpdateType: Mutable .PARAMETER Cidr + An IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing CIDR notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317: https://tools.ietf.org/html/rfc2317. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-cidr PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAction.ps1 index f3517af86..6fa378d36 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAction.ps1 @@ -1,46 +1,62 @@ function Add-VSSESReceiptRuleAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.Action resource property to the template. + Adds an AWS::SES::ReceiptRule.Action resource property to the template. An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action. .DESCRIPTION Adds an AWS::SES::ReceiptRule.Action resource property to the template. +An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action. +For information about setting up receipt rules, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html .PARAMETER BounceAction + Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service Amazon SNS. + Type: BounceAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-bounceaction UpdateType: Mutable .PARAMETER S3Action + Saves the received message to an Amazon Simple Storage Service Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS. + Type: S3Action Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-s3action UpdateType: Mutable .PARAMETER StopAction + Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS. + Type: StopAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-stopaction UpdateType: Mutable .PARAMETER SNSAction + Publishes the email content within a notification to Amazon SNS. + Type: SNSAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-snsaction UpdateType: Mutable .PARAMETER WorkmailAction + Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS. + Type: WorkmailAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction UpdateType: Mutable .PARAMETER AddHeaderAction + Adds a header to the received email. + Type: AddHeaderAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-addheaderaction UpdateType: Mutable .PARAMETER LambdaAction + Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS. + Type: LambdaAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-lambdaaction UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAddHeaderAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAddHeaderAction.ps1 index ad05cf595..35f891227 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAddHeaderAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleAddHeaderAction.ps1 @@ -1,21 +1,27 @@ function Add-VSSESReceiptRuleAddHeaderAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.AddHeaderAction resource property to the template. + Adds an AWS::SES::ReceiptRule.AddHeaderAction resource property to the template. When included in a receipt rule, this action adds a header to the received email. .DESCRIPTION Adds an AWS::SES::ReceiptRule.AddHeaderAction resource property to the template. +When included in a receipt rule, this action adds a header to the received email. +For information about adding a header using a receipt rule, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-add-header.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html .PARAMETER HeaderValue + The content that you want to include in the header. This value can contain up to 2048 characters. It can't contain newline n or carraige return r characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headervalue PrimitiveType: String UpdateType: Mutable .PARAMETER HeaderName + The name of the header that you want to add to the incoming message. The name has to contain at least one character, and can contain up to 50 characters. It can only consist of alphanumeric a–z, A–Z, 0–9 characters and dashes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 index 2f854c81a..9fc9e4ada 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 @@ -1,36 +1,48 @@ function Add-VSSESReceiptRuleBounceAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.BounceAction resource property to the template. + Adds an AWS::SES::ReceiptRule.BounceAction resource property to the template. When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. .DESCRIPTION Adds an AWS::SES::ReceiptRule.BounceAction resource property to the template. +When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. +For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html .PARAMETER Sender + The email address of the sender of the bounced email. This is the address that the bounce message is sent from. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-sender PrimitiveType: String UpdateType: Mutable .PARAMETER SmtpReplyCode + The SMTP reply code, as defined by RFC 5321: https://tools.ietf.org/html/rfc5321. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-smtpreplycode PrimitiveType: String UpdateType: Mutable .PARAMETER Message + Human-readable text to include in the bounce message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-message PrimitiveType: String UpdateType: Mutable .PARAMETER TopicArn + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-topicarn PrimitiveType: String UpdateType: Mutable .PARAMETER StatusCode + The SMTP enhanced status code, as defined by RFC 3463: https://tools.ietf.org/html/rfc3463. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 index 6b88bc10c..a80788a79 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 @@ -1,26 +1,37 @@ function Add-VSSESReceiptRuleLambdaAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.LambdaAction resource property to the template. + Adds an AWS::SES::ReceiptRule.LambdaAction resource property to the template. When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. .DESCRIPTION Adds an AWS::SES::ReceiptRule.LambdaAction resource property to the template. +When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. +To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html. + +For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html .PARAMETER FunctionArn + The Amazon Resource Name ARN of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-functionarn PrimitiveType: String UpdateType: Mutable .PARAMETER TopicArn + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-topicarn PrimitiveType: String UpdateType: Mutable .PARAMETER InvocationType + The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide: https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html. +There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-invocationtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 index 428c522b0..bc2224b1a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 @@ -1,43 +1,62 @@ function Add-VSSESReceiptRuleRule { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.Rule resource property to the template. + Adds an AWS::SES::ReceiptRule.Rule resource property to the template. Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own. .DESCRIPTION Adds an AWS::SES::ReceiptRule.Rule resource property to the template. +Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own. +Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message. + +For information about setting up receipt rules, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html .PARAMETER ScanEnabled + If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-scanenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Recipients + Containts the recipient domains and email addresses that the receipt rule applies to. If this field isn't specified, this rule matches all recipients on all verified domains. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-recipients UpdateType: Mutable .PARAMETER Actions + An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-actions ItemType: Action UpdateType: Mutable .PARAMETER Enabled + If true, the receipt rule is active. The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The name of the receipt rule. The name must: ++ This value can only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ Start and end with a letter or number. ++ Contain fewer than 64 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-name PrimitiveType: String UpdateType: Immutable .PARAMETER TlsPolicy + Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security TLS. If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-tlspolicy PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 index a21725ead..ff78c9c23 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 @@ -1,31 +1,51 @@ function Add-VSSESReceiptRuleS3Action { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.S3Action resource property to the template. + Adds an AWS::SES::ReceiptRule.S3Action resource property to the template. When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3 bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. .DESCRIPTION Adds an AWS::SES::ReceiptRule.S3Action resource property to the template. +When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3 bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. +To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html. + +**Note** + +When you save your emails to an Amazon S3 bucket, the maximum email size (including headers is 30 MB. Emails that are larger than 30 MB aren't saved. + +For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html .PARAMETER BucketName + The name of the Amazon S3 bucket that you want to send incoming mail to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER KmsKeyArn + The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key that you created in AWS KMS as follows: ++ To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West Oregon Region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key. ++ To use a custom master key that you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html. +For more information about key policies, see the AWS KMS Developer Guide: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html. If you don't specify a master key, Amazon SES doesn't encrypt your emails. +Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It isn't encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java: http://aws.amazon.com/sdk-for-java/ and AWS SDK for Ruby: http://aws.amazon.com/sdk-for-ruby/ only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-kmskeyarn PrimitiveType: String UpdateType: Mutable .PARAMETER TopicArn + The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn PrimitiveType: String UpdateType: Mutable .PARAMETER ObjectKeyPrefix + The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-objectkeyprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 index ad54a009d..44801f429 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 @@ -1,21 +1,33 @@ function Add-VSSESReceiptRuleSNSAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.SNSAction resource property to the template. + Adds an AWS::SES::ReceiptRule.SNSAction resource property to the template. When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS. This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They don't include the email content itself. .DESCRIPTION Adds an AWS::SES::ReceiptRule.SNSAction resource property to the template. +When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS. This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They don't include the email content itself. +If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html. + +**Important** + +You can only publish emails that are 150 KB or less (including the header to Amazon SNS. Emails that are larger than 150 KB aren't published. If you anticipate emails larger than 150 KB, use the S3 action instead. + +For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html .PARAMETER TopicArn + The Amazon Resource Name ARN of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn PrimitiveType: String UpdateType: Mutable .PARAMETER Encoding + The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 index 5574af41c..b3873803a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 @@ -1,21 +1,27 @@ function Add-VSSESReceiptRuleStopAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.StopAction resource property to the template. + Adds an AWS::SES::ReceiptRule.StopAction resource property to the template. When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. .DESCRIPTION Adds an AWS::SES::ReceiptRule.StopAction resource property to the template. +When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. +For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html .PARAMETER Scope + The name of the RuleSet that is being stopped. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-scope PrimitiveType: String UpdateType: Mutable .PARAMETER TopicArn + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-topicarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 index c0be3fb83..d50058906 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 @@ -1,21 +1,27 @@ function Add-VSSESReceiptRuleWorkmailAction { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule.WorkmailAction resource property to the template. + Adds an AWS::SES::ReceiptRule.WorkmailAction resource property to the template. When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. It usually isn't necessary to use this action directly, because Amazon WorkMail adds the rule automatically during its setup procedure. .DESCRIPTION Adds an AWS::SES::ReceiptRule.WorkmailAction resource property to the template. +When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS. It usually isn't necessary to use this action directly, because Amazon WorkMail adds the rule automatically during its setup procedure. +For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html .PARAMETER TopicArn + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn PrimitiveType: String UpdateType: Mutable .PARAMETER OrganizationArn + The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide: https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-organizationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESTemplateTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESTemplateTemplate.ps1 index 8dcbba4cd..253f50a94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESTemplateTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESTemplateTemplate.ps1 @@ -1,31 +1,39 @@ function Add-VSSESTemplateTemplate { <# .SYNOPSIS - Adds an AWS::SES::Template.Template resource property to the template. + Adds an AWS::SES::Template.Template resource property to the template. The content of the email, composed of a subject line, an HTML part, and a text-only part. .DESCRIPTION Adds an AWS::SES::Template.Template resource property to the template. - +The content of the email, composed of a subject line, an HTML part, and a text-only part. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html .PARAMETER HtmlPart + The HTML body of the email. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-htmlpart PrimitiveType: String UpdateType: Mutable .PARAMETER TextPart + The email body that is visible to recipients whose email clients don't display HTML content. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-textpart PrimitiveType: String UpdateType: Mutable .PARAMETER TemplateName + The name of the template. You specify this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-templatename PrimitiveType: String UpdateType: Immutable .PARAMETER SubjectPart + The subject line of the email. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-subjectpart PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 index a83232b69..ba1b12578 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 @@ -1,21 +1,29 @@ function Add-VSSNSTopicSubscription { <# .SYNOPSIS - Adds an AWS::SNS::Topic.Subscription resource property to the template. + Adds an AWS::SNS::Topic.Subscription resource property to the template. Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic. .DESCRIPTION Adds an AWS::SNS::Topic.Subscription resource property to the template. +Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic. +**Note** + +For full control over subscription behavior such as delivery policy, filtering, raw message delivery, cross-region subscriptions, etc. use AWS::SNS::Subscription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html resource instead of this embedded property . .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html .PARAMETER Endpoint + The endpoint that receives notifications from the Amazon SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the Subscribe: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html action in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html#cfn-sns-topic-subscription-endpoint PrimitiveType: String UpdateType: Immutable .PARAMETER Protocol + The subscription's protocol. For more information, see the Protocol parameter of the Subscribe: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html action in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html#cfn-sns-topic-subscription-protocol PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationInstanceAssociationOutputLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationInstanceAssociationOutputLocation.ps1 index aae402d55..98e909ec4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationInstanceAssociationOutputLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationInstanceAssociationOutputLocation.ps1 @@ -1,16 +1,18 @@ function Add-VSSSMAssociationInstanceAssociationOutputLocation { <# .SYNOPSIS - Adds an AWS::SSM::Association.InstanceAssociationOutputLocation resource property to the template. + Adds an AWS::SSM::Association.InstanceAssociationOutputLocation resource property to the template. InstanceAssociationOutputLocation is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies an Amazon S3 bucket where you want to store the results of this association request. .DESCRIPTION Adds an AWS::SSM::Association.InstanceAssociationOutputLocation resource property to the template. - +InstanceAssociationOutputLocation is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies an Amazon S3 bucket where you want to store the results of this association request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html .PARAMETER S3Location + S3OutputLocation is a property of the InstanceAssociationOutputLocation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html property that specifies an Amazon S3 bucket where you want to store the results of this request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location Type: S3OutputLocation UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationParameterValues.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationParameterValues.ps1 index 2f70c16a2..05d95c1e7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationParameterValues.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationParameterValues.ps1 @@ -1,16 +1,18 @@ function Add-VSSSMAssociationParameterValues { <# .SYNOPSIS - Adds an AWS::SSM::Association.ParameterValues resource property to the template. + Adds an AWS::SSM::Association.ParameterValues resource property to the template. ParameterValues is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies the parameters for the runtime configuration of the document. .DESCRIPTION Adds an AWS::SSM::Association.ParameterValues resource property to the template. - +ParameterValues is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies the parameters for the runtime configuration of the document. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-parametervalues.html .PARAMETER ParameterValues + The parameters for the runtime configuration of the document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-parametervalues.html#cfn-ssm-association-parametervalues-parametervalues DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationS3OutputLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationS3OutputLocation.ps1 index a31b693d4..6df439cc2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationS3OutputLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationS3OutputLocation.ps1 @@ -1,21 +1,25 @@ function Add-VSSSMAssociationS3OutputLocation { <# .SYNOPSIS - Adds an AWS::SSM::Association.S3OutputLocation resource property to the template. + Adds an AWS::SSM::Association.S3OutputLocation resource property to the template. S3OutputLocation is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies an Amazon S3 bucket where you want to store the results of this association request. .DESCRIPTION Adds an AWS::SSM::Association.S3OutputLocation resource property to the template. - +S3OutputLocation is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies an Amazon S3 bucket where you want to store the results of this association request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html .PARAMETER OutputS3BucketName + The name of the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER OutputS3KeyPrefix + The Amazon S3 bucket subfolder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 index 2c3e71318..531a04524 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 @@ -1,21 +1,25 @@ function Add-VSSSMAssociationTarget { <# .SYNOPSIS - Adds an AWS::SSM::Association.Target resource property to the template. + Adds an AWS::SSM::Association.Target resource property to the template. Target is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies the targets for an SSM document in Systems Manager. .DESCRIPTION Adds an AWS::SSM::Association.Target resource property to the template. - +Target is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html resource that specifies the targets for an SSM document in Systems Manager. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html .PARAMETER Key + User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag: or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting in the *AWS Systems Manager User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key PrimitiveType: String UpdateType: Immutable .PARAMETER Values + User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html in the *AWS Systems Manager User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 index a32c9831b..a7461a313 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 @@ -1,22 +1,28 @@ function Add-VSSSMMaintenanceWindowTargetTargets { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTarget.Targets resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTarget.Targets resource property to the template. The Targets property type specifies adding a target to a maintenance window target in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTarget.Targets resource property to the template. +The Targets property type specifies adding a target to a maintenance window target in AWS Systems Manager. +Targets is a property of the AWS::SSM::MaintenanceWindowTarget: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html .PARAMETER Values + User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html in the *AWS Systems Manager User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-values UpdateType: Mutable .PARAMETER Key + User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag: or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting in the *AWS Systems Manager User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskLoggingInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskLoggingInfo.ps1 index 3a6f17888..2c283955f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskLoggingInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskLoggingInfo.ps1 @@ -1,26 +1,38 @@ function Add-VSSSMMaintenanceWindowTaskLoggingInfo { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.LoggingInfo resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.LoggingInfo resource property to the template. The LoggingInfo property type specifies information about the Amazon S3 bucket to write instance-level logs to. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.LoggingInfo resource property to the template. +The LoggingInfo property type specifies information about the Amazon S3 bucket to write instance-level logs to. +LoggingInfo is a property of the AWS::SSM::MaintenanceWindowTask: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html resource. + +**Note** + +LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html .PARAMETER S3Bucket + The name of an Amazon S3 bucket where execution logs are stored . + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Region + The region where the Amazon S3 bucket is located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region PrimitiveType: String UpdateType: Mutable .PARAMETER S3Prefix + The Amazon S3 bucket subfolder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowAutomationParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowAutomationParameters.ps1 index 52b1acc65..a16621263 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowAutomationParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowAutomationParameters.ps1 @@ -1,21 +1,27 @@ function Add-VSSSMMaintenanceWindowTaskMaintenanceWindowAutomationParameters { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters resource property to the template. The MaintenanceWindowAutomationParameters property type specifies the parameters for an AUTOMATION task type for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters resource property to the template. +The MaintenanceWindowAutomationParameters property type specifies the parameters for an AUTOMATION task type for a maintenance window task in AWS Systems Manager. +MaintenanceWindowAutomationParameters is a property of the TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html .PARAMETER Parameters + The parameters for the AUTOMATION task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER DocumentVersion + The version of an Automation document to use during task execution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowLambdaParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowLambdaParameters.ps1 index ab11ba84e..da9ed48eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowLambdaParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowLambdaParameters.ps1 @@ -1,26 +1,34 @@ function Add-VSSSMMaintenanceWindowTaskMaintenanceWindowLambdaParameters { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters resource property to the template. The MaintenanceWindowLambdaParameters property type specifies the parameters for a LAMBDA task type for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters resource property to the template. +The MaintenanceWindowLambdaParameters property type specifies the parameters for a LAMBDA task type for a maintenance window task in AWS Systems Manager. +MaintenanceWindowLambdaParameters is a property of the TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html .PARAMETER ClientContext + Client-specific information to pass to the Lambda function that you're invoking. You can then use the context variable to process the client information in your Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext PrimitiveType: String UpdateType: Mutable .PARAMETER Qualifier + A Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier PrimitiveType: String UpdateType: Mutable .PARAMETER Payload + JSON to provide to your Lambda function as input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowRunCommandParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowRunCommandParameters.ps1 index 514737f1e..2cedac9f4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowRunCommandParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowRunCommandParameters.ps1 @@ -1,56 +1,76 @@ function Add-VSSSMMaintenanceWindowTaskMaintenanceWindowRunCommandParameters { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters resource property to the template. The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters resource property to the template. +The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager. +MaintenanceWindowRunCommandParameters is a property of the TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html .PARAMETER TimeoutSeconds + If this time is reached and the command has not already started running, it doesn't run. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER Comment + Information about the command or commands to run. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment PrimitiveType: String UpdateType: Mutable .PARAMETER OutputS3KeyPrefix + The Amazon S3 bucket subfolder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + The parameters for the RUN_COMMAND task execution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER DocumentHashType + The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceRoleArn + The ARN of the IAM service role to use to publish Amazon Simple Notification Service Amazon SNS notifications for maintenance window Run Command tasks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationConfig + Configurations for sending notifications about command status changes on a per-instance basis. + Type: NotificationConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig UpdateType: Mutable .PARAMETER OutputS3BucketName + The name of the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER DocumentHash + The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 index 11398d39e..52e2a150e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 @@ -1,21 +1,27 @@ function Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters resource property to the template. The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for execution of the STEP_FUNCTION for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters resource property to the template. +The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for execution of the STEP_FUNCTION for a maintenance window task in AWS Systems Manager. +MaintenanceWindowStepFunctionsParameters is a property of the TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html .PARAMETER Input + The inputs for the STEP_FUNCTION task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the STEP_FUNCTION task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskNotificationConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskNotificationConfig.ps1 index c35edf6e3..a8ef3d72b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskNotificationConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskNotificationConfig.ps1 @@ -1,26 +1,36 @@ function Add-VSSSMMaintenanceWindowTaskNotificationConfig { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.NotificationConfig resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.NotificationConfig resource property to the template. The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.NotificationConfig resource property to the template. +The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager. +NotificationConfig is a property of the MaintenanceWindowRunCommandParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html .PARAMETER NotificationArn + An Amazon Resource Name ARN for an Amazon Simple Notification Service Amazon SNS topic. Run Command pushes notifications about command status changes to this topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationType + The notification type. ++ Command: Receive notification when the status of a command changes. ++ Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationEvents + The different events that you can receive notifications for. These events include the following: All events, InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html in the *AWS Systems Manager User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTarget.ps1 index 10374d2aa..c94859f6d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTarget.ps1 @@ -1,22 +1,28 @@ function Add-VSSSMMaintenanceWindowTaskTarget { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.Target resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.Target resource property to the template. The Target property type specifies targets (either instances or window target IDs. You specify instances by using Key=InstanceIds,Values=,. You specify window target IDs using Key=WindowTargetIds,Values=, for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.Target resource property to the template. +The Target property type specifies targets (either instances or window target IDs. You specify instances by using Key=InstanceIds,Values=,. You specify window target IDs using Key=WindowTargetIds,Values=, for a maintenance window task in AWS Systems Manager. +Target is a property of the AWS::SSM::MaintenanceWindowTask: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html .PARAMETER Values + User-defined criteria that maps to Key. For example, if you specify InstanceIds, you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values: https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html in the *AWS Systems Manager User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values UpdateType: Mutable .PARAMETER Key + User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values: https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html in the *AWS Systems Manager User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 index cc16eead4..5cbb31685 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 @@ -1,31 +1,41 @@ function Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters resource property to the template. + Adds an AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters resource property to the template. The TaskInvocationParameters property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters resource property to the template. +The TaskInvocationParameters property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager. +TaskInvocationParameters is a property of the AWS::SSM::MaintenanceWindowTask: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html .PARAMETER MaintenanceWindowRunCommandParameters + The parameters for a RUN_COMMAND task type. + Type: MaintenanceWindowRunCommandParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters UpdateType: Mutable .PARAMETER MaintenanceWindowAutomationParameters + The parameters for an AUTOMATION task type. + Type: MaintenanceWindowAutomationParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters UpdateType: Mutable .PARAMETER MaintenanceWindowStepFunctionsParameters + The parameters for a STEP_FUNCTION task type. + Type: MaintenanceWindowStepFunctionsParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters UpdateType: Mutable .PARAMETER MaintenanceWindowLambdaParameters + The parameters for a LAMBDA task type. + Type: MaintenanceWindowLambdaParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilter.ps1 index 2c6d86ff7..eb907dc40 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilter.ps1 @@ -1,22 +1,30 @@ function Add-VSSSMPatchBaselinePatchFilter { <# .SYNOPSIS - Adds an AWS::SSM::PatchBaseline.PatchFilter resource property to the template. + Adds an AWS::SSM::PatchBaseline.PatchFilter resource property to the template. The PatchFilter property type defines a patch filter for an AWS Systems Manager patch baseline. .DESCRIPTION Adds an AWS::SSM::PatchBaseline.PatchFilter resource property to the template. +The PatchFilter property type defines a patch filter for an AWS Systems Manager patch baseline. +The PatchFilters property of the PatchFilterGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html property type contains a list of PatchFilter property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html .PARAMETER Values + The value for the filter key. +For information about valid values for each key based on operating system type, see PatchFilter: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html in the *AWS Systems Manager API Reference*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values UpdateType: Mutable .PARAMETER Key + The key for the filter. +For information about valid keys, see PatchFilter: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html in the *AWS Systems Manager API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilterGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilterGroup.ps1 index 5c41cef6f..3e17e9b17 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilterGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchFilterGroup.ps1 @@ -1,16 +1,20 @@ function Add-VSSSMPatchBaselinePatchFilterGroup { <# .SYNOPSIS - Adds an AWS::SSM::PatchBaseline.PatchFilterGroup resource property to the template. + Adds an AWS::SSM::PatchBaseline.PatchFilterGroup resource property to the template. The PatchFilterGroup property type specifies a set of patch filters for an AWS Systems Manager patch baseline, typically used for approval rules for a Systems Manager patch baseline. .DESCRIPTION Adds an AWS::SSM::PatchBaseline.PatchFilterGroup resource property to the template. +The PatchFilterGroup property type specifies a set of patch filters for an AWS Systems Manager patch baseline, typically used for approval rules for a Systems Manager patch baseline. +PatchFilterGroup is the property type for the GlobalFilters property of the AWS::SSM::PatchBaseline: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html resource and the PatchFilterGroup property of the Rule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html .PARAMETER PatchFilters + The set of patch filters that make up the group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters ItemType: PatchFilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchSource.ps1 index 03b5d8981..162f2b0e9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselinePatchSource.ps1 @@ -1,27 +1,39 @@ function Add-VSSSMPatchBaselinePatchSource { <# .SYNOPSIS - Adds an AWS::SSM::PatchBaseline.PatchSource resource property to the template. + Adds an AWS::SSM::PatchBaseline.PatchSource resource property to the template. PatchSource is the property type for the Sources resource of the AWS::SSM::PatchBaseline: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html resource. .DESCRIPTION Adds an AWS::SSM::PatchBaseline.PatchSource resource property to the template. +PatchSource is the property type for the Sources resource of the AWS::SSM::PatchBaseline: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html resource. +The AWS CloudFormation AWS::SSM::PatchSource resource is used to provide information about the patches to use to update target instances, including target operating systems and source repository. Applies to Linux instances only. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html .PARAMETER Products + The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html in the *AWS Systems Manager API Reference*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products UpdateType: Mutable .PARAMETER Configuration + The value of the yum repo configuration. For example: +main] +cachedir=/var/cache/yum/$basesearch$releasever +keepcache=0 +debuglevel=2 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name specified to identify the patch source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 index fde57ab41..e7ea69f44 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 @@ -1,31 +1,41 @@ function Add-VSSSMPatchBaselineRule { <# .SYNOPSIS - Adds an AWS::SSM::PatchBaseline.Rule resource property to the template. + Adds an AWS::SSM::PatchBaseline.Rule resource property to the template. The Rule property type specifies an approval rule for a Systems Manager patch baseline. .DESCRIPTION Adds an AWS::SSM::PatchBaseline.Rule resource property to the template. +The Rule property type specifies an approval rule for a Systems Manager patch baseline. +The PatchRules property of the RuleGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html property type contains a list of Rule property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html .PARAMETER EnableNonSecurity + For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PatchFilterGroup + The patch filter group that defines the criteria for the rule. + Type: PatchFilterGroup Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup UpdateType: Mutable .PARAMETER ApproveAfterDays + The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays PrimitiveType: Integer UpdateType: Mutable .PARAMETER ComplianceLevel + A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: UNSPECIFIED, CRITICAL, HIGH, MEDIUM, LOW, and INFORMATIONAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRuleGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRuleGroup.ps1 index ea4fafb1a..5ec6d541e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRuleGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRuleGroup.ps1 @@ -1,16 +1,20 @@ function Add-VSSSMPatchBaselineRuleGroup { <# .SYNOPSIS - Adds an AWS::SSM::PatchBaseline.RuleGroup resource property to the template. + Adds an AWS::SSM::PatchBaseline.RuleGroup resource property to the template. The RuleGroup property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline. .DESCRIPTION Adds an AWS::SSM::PatchBaseline.RuleGroup resource property to the template. +The RuleGroup property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline. +RuleGroup is the property type for the ApprovalRules property of the AWS::SSM::PatchBaseline: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html .PARAMETER PatchRules + The rules that make up the rule group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules ItemType: Rule diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerCodeRepositoryGitConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerCodeRepositoryGitConfig.ps1 index 846f99424..b5abcd453 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerCodeRepositoryGitConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerCodeRepositoryGitConfig.ps1 @@ -1,26 +1,33 @@ function Add-VSSageMakerCodeRepositoryGitConfig { <# .SYNOPSIS - Adds an AWS::SageMaker::CodeRepository.GitConfig resource property to the template. + Adds an AWS::SageMaker::CodeRepository.GitConfig resource property to the template. Specifies configuration details for a Git repository in your AWS account. .DESCRIPTION Adds an AWS::SageMaker::CodeRepository.GitConfig resource property to the template. - +Specifies configuration details for a Git repository in your AWS account. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html .PARAMETER SecretArn + The Amazon Resource Name ARN of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format: +{"username": UserName, "password": Password} + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-secretarn PrimitiveType: String UpdateType: Mutable .PARAMETER Branch + The default branch for the Git repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-branch PrimitiveType: String UpdateType: Immutable .PARAMETER RepositoryUrl + The URL where the Git repository is located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-repositoryurl PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 index 88f286d87..2fe587030 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 @@ -1,41 +1,53 @@ function Add-VSSageMakerEndpointConfigProductionVariant { <# .SYNOPSIS - Adds an AWS::SageMaker::EndpointConfig.ProductionVariant resource property to the template. + Adds an AWS::SageMaker::EndpointConfig.ProductionVariant resource property to the template. Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitiaVariantWeight objects. .DESCRIPTION Adds an AWS::SageMaker::EndpointConfig.ProductionVariant resource property to the template. - +Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitiaVariantWeight objects. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html .PARAMETER ModelName + The name of the model that you want to host. This is the name that you specified when creating the model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-modelname PrimitiveType: String UpdateType: Immutable .PARAMETER VariantName + The name of the production variant. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-variantname PrimitiveType: String UpdateType: Immutable .PARAMETER InitialInstanceCount + Number of instances to launch initially. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialinstancecount PrimitiveType: Integer UpdateType: Immutable .PARAMETER InstanceType + The ML compute instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER AcceleratorType + The size of the Elastic Inference EI instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker: http://docs.aws.amazon.com/sagemaker/latest/dg/ei.html. For more information, see Using Elastic Inference in Amazon SageMaker: http://docs.aws.amazon.com/sagemaker/latest/dg/ei.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-acceleratortype PrimitiveType: String UpdateType: Immutable .PARAMETER InitialVariantWeight + Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialvariantweight PrimitiveType: Double UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 index 11d36ffff..0591d346b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 @@ -1,36 +1,49 @@ function Add-VSSageMakerModelContainerDefinition { <# .SYNOPSIS - Adds an AWS::SageMaker::Model.ContainerDefinition resource property to the template. + Adds an AWS::SageMaker::Model.ContainerDefinition resource property to the template. Describes the container, as part of model definition. .DESCRIPTION Adds an AWS::SageMaker::Model.ContainerDefinition resource property to the template. - +Describes the container, as part of model definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html .PARAMETER ContainerHostname + This parameter is ignored for models that contain only a PrimaryContainer. +When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline: http://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-containerhostname PrimitiveType: String UpdateType: Immutable .PARAMETER Mode + *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-mode PrimitiveType: String UpdateType: Immutable .PARAMETER Environment + The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-environment PrimitiveType: Json UpdateType: Immutable .PARAMETER ModelDataUrl + The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive .tar.gz suffix. The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters: http://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html. +If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html in the *AWS Identity and Access Management User Guide*. +If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modeldataurl PrimitiveType: String UpdateType: Immutable .PARAMETER Image + The Amazon EC2 Container Registry Amazon ECR path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository:tag] and registry/repository@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-image PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 index 000c6ed51..84f572a21 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 @@ -1,22 +1,27 @@ function Add-VSSageMakerModelVpcConfig { <# .SYNOPSIS - Adds an AWS::SageMaker::Model.VpcConfig resource property to the template. + Adds an AWS::SageMaker::Model.VpcConfig resource property to the template. Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html and Protect Training Jobs by Using an Amazon Virtual Private Cloud: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html. .DESCRIPTION Adds an AWS::SageMaker::Model.VpcConfig resource property to the template. - +Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html and Protect Training Jobs by Using an Amazon Virtual Private Cloud: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-vpcconfig.html .PARAMETER Subnets + The ID of the subnets in the VPC to which you want to connect your training job or model. +Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-vpcconfig.html#cfn-sagemaker-model-vpcconfig-subnets UpdateType: Immutable .PARAMETER SecurityGroupIds + The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-vpcconfig.html#cfn-sagemaker-model-vpcconfig-securitygroupids diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerNotebookInstanceLifecycleConfigNotebookInstanceLifecycleHook.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerNotebookInstanceLifecycleConfigNotebookInstanceLifecycleHook.ps1 index e10302c65..8131a39d4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerNotebookInstanceLifecycleConfigNotebookInstanceLifecycleHook.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerNotebookInstanceLifecycleConfigNotebookInstanceLifecycleHook.ps1 @@ -1,16 +1,18 @@ function Add-VSSageMakerNotebookInstanceLifecycleConfigNotebookInstanceLifecycleHook { <# .SYNOPSIS - Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHook resource property to the template. + Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHook resource property to the template. Specifies the notebook instance lifecycle configuration script. Each lifecycle configuration script has a limit of 16384 characters. .DESCRIPTION Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHook resource property to the template. - +Specifies the notebook instance lifecycle configuration script. Each lifecycle configuration script has a limit of 16384 characters. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecyclehook.html .PARAMETER Content + A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecyclehook.html#cfn-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecyclehook-content PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamCognitoMemberDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamCognitoMemberDefinition.ps1 index 1e3b9208c..856b6302c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamCognitoMemberDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamCognitoMemberDefinition.ps1 @@ -1,26 +1,32 @@ function Add-VSSageMakerWorkteamCognitoMemberDefinition { <# .SYNOPSIS - Adds an AWS::SageMaker::Workteam.CognitoMemberDefinition resource property to the template. + Adds an AWS::SageMaker::Workteam.CognitoMemberDefinition resource property to the template. Identifies a Amazon Cognito user group. A user group can be used in on or more work teams. .DESCRIPTION Adds an AWS::SageMaker::Workteam.CognitoMemberDefinition resource property to the template. - +Identifies a Amazon Cognito user group. A user group can be used in on or more work teams. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html .PARAMETER CognitoUserPool + An identifier for a user pool. The user pool must be in the same region as the service that you are calling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitouserpool PrimitiveType: String UpdateType: Immutable .PARAMETER CognitoClientId + An identifier for an application client. You must create the app client ID using Amazon Cognito. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitoclientid PrimitiveType: String UpdateType: Mutable .PARAMETER CognitoUserGroup + An identifier for a user group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitousergroup PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamMemberDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamMemberDefinition.ps1 index 9f25f16bf..193566346 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamMemberDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamMemberDefinition.ps1 @@ -1,16 +1,18 @@ function Add-VSSageMakerWorkteamMemberDefinition { <# .SYNOPSIS - Adds an AWS::SageMaker::Workteam.MemberDefinition resource property to the template. + Adds an AWS::SageMaker::Workteam.MemberDefinition resource property to the template. Defines the Amazon Cognito user group that is part of a work team. .DESCRIPTION Adds an AWS::SageMaker::Workteam.MemberDefinition resource property to the template. - +Defines the Amazon Cognito user group that is part of a work team. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html .PARAMETER CognitoMemberDefinition + The Amazon Cognito user group that is part of the work team. + Type: CognitoMemberDefinition Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-cognitomemberdefinition UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamNotificationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamNotificationConfiguration.ps1 index a1a059dc0..72682d400 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamNotificationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerWorkteamNotificationConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSSageMakerWorkteamNotificationConfiguration { <# .SYNOPSIS - Adds an AWS::SageMaker::Workteam.NotificationConfiguration resource property to the template. + Adds an AWS::SageMaker::Workteam.NotificationConfiguration resource property to the template. Configures SNS notifications of available or expiring work items for work teams. .DESCRIPTION Adds an AWS::SageMaker::Workteam.NotificationConfiguration resource property to the template. - +Configures SNS notifications of available or expiring work items for work teams. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-notificationconfiguration.html .PARAMETER NotificationTopicArn + The ARN for the SNS topic to which notifications should be published. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-notificationconfiguration.html#cfn-sagemaker-workteam-notificationconfiguration-notificationtopicarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 index 222277316..0813490d4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 @@ -1,16 +1,19 @@ function Add-VSSecretsManagerRotationScheduleRotationRules { <# .SYNOPSIS - Adds an AWS::SecretsManager::RotationSchedule.RotationRules resource property to the template. + Adds an AWS::SecretsManager::RotationSchedule.RotationRules resource property to the template. The RotationRules property is used as part of the AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type to configure how and when Secrets Manager performs rotation for the associated secret. .DESCRIPTION Adds an AWS::SecretsManager::RotationSchedule.RotationRules resource property to the template. - +The RotationRules property is used as part of the AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type to configure how and when Secrets Manager performs rotation for the associated secret. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html .PARAMETER AutomaticallyAfterDays + Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation. +You can specify a minimum value of 1 and a maximum value of 1000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html#cfn-secretsmanager-rotationschedule-rotationrules-automaticallyafterdays PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 index 6dbefc3b3..f18d97c53 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 @@ -1,61 +1,87 @@ function Add-VSSecretsManagerSecretGenerateSecretString { <# .SYNOPSIS - Adds an AWS::SecretsManager::Secret.GenerateSecretString resource property to the template. + Adds an AWS::SecretsManager::Secret.GenerateSecretString resource property to the template. Use the GenerateSecretStringproperty as part of the AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type to dynamically generate a random text string to use as a password. It is an alternative to hardcoding a password directly in the SecretString property. When you generate a AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type, you must include one or the other, but not both. .DESCRIPTION Adds an AWS::SecretsManager::Secret.GenerateSecretString resource property to the template. +Use the GenerateSecretStringproperty as part of the AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type to dynamically generate a random text string to use as a password. It is an alternative to hardcoding a password directly in the SecretString property. When you generate a AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type, you must include one or the other, but not both. +SecretString enables you to place a literal value directly into the secret (a technique that we recommend you avoid. Instead, we recommend that you use the GenerateSecretString property to dynamically generate a random password. The operation returns a complete JSON structure to use as the secret value. The structure begins with the string that you supply using the SecretStringTemplate. This template string must be a properly formatted JSON string that contains all of the secret value information except the password. The operation then generates a random password using the rules specified by the other parameters. Finally, the operations inserts the generated password into the secret value structure along with the JSON key name that's specified by the GenerateStringKey parameter. + +For examples, see AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html .PARAMETER ExcludeUppercase + Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is False, and the generated password can include uppercase letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludeuppercase PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RequireEachIncludedType + Specifies whether the generated password must include at least one of every allowed character type. If you don't include this switch, the default value is True, and the generated password includes at least one of every character type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-requireeachincludedtype PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeSpace + Specifies that the generated password can include the space character. The default if you do not include this switch parameter is False, and the generated password doesn't include space characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-includespace PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExcludeCharacters + A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludecharacters PrimitiveType: String UpdateType: Mutable .PARAMETER GenerateStringKey + The JSON key name that's used to add the generated password to the JSON structure specified by the SecretStringTemplateparameter. If you specify this parameter, then you must also specify SecretStringTemplate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-generatestringkey PrimitiveType: String UpdateType: Mutable .PARAMETER PasswordLength + The desired length of the generated password. The default value if you do not include this parameter is 32 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-passwordlength PrimitiveType: Integer UpdateType: Mutable .PARAMETER ExcludePunctuation + Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. +The following are the punctuation characters that *can* be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation: +! " # $ % & ' * + , - . / : ; < = > ? @ ] ^ _ { | } ~ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludepunctuation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExcludeLowercase + Specifies that the generated password should not include lowercase letters. The default if you don't include this switch parameter is False, and the generated password can include lowercase letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludelowercase PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SecretStringTemplate + A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey. That key is combined with the generated random string and inserted into the JSON structure that's specified by this parameter. The merged JSON string is returned as the completed SecretStringof the secret. The default if you don't include this parameter is that the generated random password string is returned by itself, and isn't embeded in a JSON structure. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-secretstringtemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ExcludeNumbers + Specifies that the generated password should not include digits. The default if you don't include this switch parameter is False, and the generated password can include digits. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludenumbers PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProductProvisioningArtifactProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProductProvisioningArtifactProperties.ps1 index b87aced0b..12d8adeb4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProductProvisioningArtifactProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProductProvisioningArtifactProperties.ps1 @@ -1,31 +1,40 @@ function Add-VSServiceCatalogCloudFormationProductProvisioningArtifactProperties { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties resource property to the template. + Adds an AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties resource property to the template. Information about a provisioning artifact (also known as a version for a product. .DESCRIPTION Adds an AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties resource property to the template. - +Information about a provisioning artifact (also known as a version for a product. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html .PARAMETER Description + The description of the provisioning artifact, including how it differs from the previous provisioning artifact. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-description PrimitiveType: String UpdateType: Mutable .PARAMETER DisableTemplateValidation + If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-disabletemplatevalidation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Info + The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows: +"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-info PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the provisioning artifact for example, v1 v2beta. No spaces are allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningParameter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningParameter.ps1 index 61034a3d6..4f66d1420 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningParameter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningParameter.ps1 @@ -1,21 +1,25 @@ function Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningParameter { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter resource property to the template. + Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter resource property to the template. Information about a parameter used to provision a product. .DESCRIPTION Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter resource property to the template. - +Information about a parameter used to provision a product. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html .PARAMETER Value + The parameter value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The parameter key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningPreferences.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningPreferences.ps1 index 4633153ce..9981f47a4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningPreferences.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningPreferences.ps1 @@ -1,48 +1,88 @@ function Add-VSServiceCatalogCloudFormationProvisionedProductProvisioningPreferences { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences resource property to the template. + Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences resource property to the template. The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types. .DESCRIPTION Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences resource property to the template. - +The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html .PARAMETER StackSetAccounts + One or more AWS accounts that will have access to the provisioned product. +Applicable only to a CFN_STACKSET provisioned product type. +The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation. +If no values are specified, the default value is all accounts from the STACKSET constraint. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetaccounts UpdateType: Mutable .PARAMETER StackSetFailureToleranceCount + The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. +Applicable only to a CFN_STACKSET provisioned product type. +Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. +The default value is 0 if no value is specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetfailuretolerancecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER StackSetMaxConcurrencyPercentage + The maximum percentage of accounts in which to perform this operation at one time. +When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. +Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. +Applicable only to a CFN_STACKSET provisioned product type. +Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetmaxconcurrencypercentage PrimitiveType: Integer UpdateType: Mutable .PARAMETER StackSetMaxConcurrencyCount + The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount. +Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. +Applicable only to a CFN_STACKSET provisioned product type. +Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetmaxconcurrencycount PrimitiveType: Integer UpdateType: Mutable .PARAMETER StackSetRegions + One or more AWS Regions where the provisioned product will be available. +Applicable only to a CFN_STACKSET provisioned product type. +The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation. +If no values are specified, the default value is all regions from the STACKSET constraint. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetregions UpdateType: Mutable .PARAMETER StackSetOperationType + Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified. +Applicable only to a CFN_STACKSET provisioned product type. +CREATE +Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored. +UPDATE +Updates the stack set represented by the provisioned product and also its stack instances. +DELETE +Deletes a stack instance in the stack set represented by the provisioned product. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetoperationtype PrimitiveType: String UpdateType: Mutable .PARAMETER StackSetFailureTolerancePercentage + The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. +When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. +Applicable only to a CFN_STACKSET provisioned product type. +Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetfailuretolerancepercentage PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 index 2c856dbd3..ffee0996b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 @@ -1,27 +1,45 @@ function Add-VSServiceDiscoveryServiceDnsConfig { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Service.DnsConfig resource property to the template. + Adds an AWS::ServiceDiscovery::Service.DnsConfig resource property to the template. A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. .DESCRIPTION Adds an AWS::ServiceDiscovery::Service.DnsConfig resource property to the template. - +A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html .PARAMETER DnsRecords + An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-dnsrecords ItemType: DnsRecord UpdateType: Mutable .PARAMETER RoutingPolicy + The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service. +If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy. +You can specify the following values: +**MULTIVALUE** +If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances. +For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances. +If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances. +For more information about the multivalue routing policy, see Multivalue Answer Routing: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue in the *Route 53 Developer Guide*. +**WEIGHTED** +Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances. +For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy. +If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance. +For more information about the weighted routing policy, see Weighted Routing: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted in the *Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-routingpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER NamespaceId + The ID of the namespace to use for DNS configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-namespaceid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsRecord.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsRecord.ps1 index 504a91b89..12d966062 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsRecord.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsRecord.ps1 @@ -1,21 +1,56 @@ function Add-VSServiceDiscoveryServiceDnsRecord { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Service.DnsRecord resource property to the template. + Adds an AWS::ServiceDiscovery::Service.DnsRecord resource property to the template. A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. .DESCRIPTION Adds an AWS::ServiceDiscovery::Service.DnsRecord resource property to the template. - +A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html .PARAMETER Type + The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations: ++ A ++ AAAA ++ A and AAAA ++ SRV ++ CNAME +If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type. +You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html. +The following values are supported: +**A** +Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44. +**AAAA** +Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345. +**CNAME** +Route 53 returns the domain name of the resource, such as www.example.com. Note the following: ++ You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes in the topic RegisterInstance: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html. ++ You must specify WEIGHTED for the value of RoutingPolicy. ++ You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error. +**SRV** +Route 53 returns the value for an SRV record. The value for an SRV record uses the following values: +priority weight port service-hostname +Note the following about the values: ++ The values of priority and weight are both set to 1 and can't be changed. ++ The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html request. ++ The value of service-hostname is a concatenation of the following values: ++ The value that you specify for InstanceId when you register an instance. ++ The name of the service. ++ The name of the namespace. +For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is: +test.backend.example.com +If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-type PrimitiveType: String UpdateType: Mutable .PARAMETER TTL + The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record. +Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-ttl PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 index 0259c7b78..8739e02e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 @@ -1,26 +1,78 @@ function Add-VSServiceDiscoveryServiceHealthCheckConfig { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Service.HealthCheckConfig resource property to the template. + Adds an AWS::ServiceDiscovery::Service.HealthCheckConfig resource property to the template. *Public DNS namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. .DESCRIPTION Adds an AWS::ServiceDiscovery::Service.HealthCheckConfig resource property to the template. +*Public DNS namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. +**Important** + +If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. + +Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing: http://aws.amazon.com/route53/pricing/. + +Note the following about configuring health checks. + +**A and AAAA records** + +If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy. + +**CNAME records** + +You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error. + +**Request interval** + +A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all. + +**Health checking regions** + +Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions. + +**Alias records** + +When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following: + ++ Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth. + ++ If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check. + +**Charges for health checks** + +Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing: http://aws.amazon.com/route53/pricing/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html .PARAMETER Type + The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. +You can't change the value of Type after you create a health check. +You can create the following types of health checks: ++ **HTTP**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. ++ **HTTPS**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. +**Important** +If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later. ++ **TCP**: Route 53 tries to establish a TCP connection. +If you specify TCP for Type, don't specify a value for ResourcePath. +For more information, see How Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html in the *Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-type PrimitiveType: String UpdateType: Mutable .PARAMETER ResourcePath + The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /. +If you specify TCP for Type, you must *not* specify a value for ResourcePath. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-resourcepath PrimitiveType: String UpdateType: Mutable .PARAMETER FailureThreshold + The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html in the *Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-failurethreshold PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 index 9c89b3ae7..515254135 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 @@ -1,16 +1,53 @@ function Add-VSServiceDiscoveryServiceHealthCheckCustomConfig { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Service.HealthCheckCustomConfig resource property to the template. + Adds an AWS::ServiceDiscovery::Service.HealthCheckCustomConfig resource property to the template. A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances: .DESCRIPTION Adds an AWS::ServiceDiscovery::Service.HealthCheckCustomConfig resource property to the template. +A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances: ++ You can't use a health check that is defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC. + ++ You want to use a third-party health checker regardless of where your resources are. + +**Important** + +If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. + +To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request. + +Here's how custom health checks work: + +1. You create a service and specify a value for FailureThreshold. + +The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource. + +1. You register an instance. + +1. You configure a third-party health checker to monitor the resource that is associated with the new instance. + +**Note** + +AWS Cloud Map doesn't check the health of the resource directly. + +1. The third-party health-checker determines that the resource is unhealthy and notifies your application. + +1. Your application submits an UpdateInstanceCustomHealthStatus request. + +1. AWS Cloud Map waits for (FailureThreshold x 30 seconds. + +1. If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource. + +Note the following about configuring custom health checks. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html .PARAMETER FailureThreshold + The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds 2 x 30 before changing the status of the service instance based on that request. +Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html#cfn-servicediscovery-service-healthcheckcustomconfig-failurethreshold PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsActivityTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsActivityTagsEntry.ps1 index 564f0185e..998640a1f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsActivityTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsActivityTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSStepFunctionsActivityTagsEntry { <# .SYNOPSIS - Adds an AWS::StepFunctions::Activity.TagsEntry resource property to the template. + Adds an AWS::StepFunctions::Activity.TagsEntry resource property to the template. The TagsEntry property specifies *tags* to identify an activity. .DESCRIPTION Adds an AWS::StepFunctions::Activity.TagsEntry resource property to the template. - +The TagsEntry property specifies *tags* to identify an activity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html .PARAMETER Value + The value for a key-value pair in a tag entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key for a key-value pair in a tag entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineTagsEntry.ps1 index 3a04b33e5..55c8fd7bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSStepFunctionsStateMachineTagsEntry { <# .SYNOPSIS - Adds an AWS::StepFunctions::StateMachine.TagsEntry resource property to the template. + Adds an AWS::StepFunctions::StateMachine.TagsEntry resource property to the template. The TagsEntry property specifies *tags* to identify a state machine. .DESCRIPTION Adds an AWS::StepFunctions::StateMachine.TagsEntry resource property to the template. - +The TagsEntry property specifies *tags* to identify a state machine. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html .PARAMETER Value + The value for a key-value pair in a tag entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key for a key-value pair in a tag entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 index 94df8e24a..78d0add7f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 @@ -1,21 +1,41 @@ function Add-VSTag { <# .SYNOPSIS - Adds an Tag resource property to the template. + Adds an Tag resource property to the template. You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources. You can tag only resources for which AWS CloudFormation supports tagging. For information about which resources you can tag with AWS CloudFormation, see the individual resources in AWS Resource and Property Types Reference: aws-template-resource-type-ref.md. .DESCRIPTION Adds an Tag resource property to the template. +You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources. You can tag only resources for which AWS CloudFormation supports tagging. For information about which resources you can tag with AWS CloudFormation, see the individual resources in AWS Resource and Property Types Reference: aws-template-resource-type-ref.md. +**Note** + +Tagging implementations might vary by resource. For example, AWS::AutoScaling::AutoScalingGroup provides an additional, required PropagateAtLaunch property as part of its tagging scheme. + +In addition to any tags you define, AWS CloudFormation automatically creates the following stack-level tags with the prefix aws:: + ++ aws:cloudformation:logical-id + ++ aws:cloudformation:stack-id + ++ aws:cloudformation:stack-name + +The aws: prefix is reserved for AWS use. This prefix is case-insensitive. If you use this prefix in the Key or Value property, you cannot update or delete the tag. Tags with this prefix don't count toward the number of tags per resource. + +All stack-level tags, including automatically created tags, are propagated to resources that AWS CloudFormation supports. Currently, tags are not propagated to Amazon EBS volumes that are created from block device mappings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html .PARAMETER Key + The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html#cfn-resource-tags-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html#cfn-resource-tags-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 index abeb35dbc..5bd34ca77 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 @@ -1,32 +1,40 @@ function Add-VSTransferServerEndpointDetails { <# .SYNOPSIS - Adds an AWS::Transfer::Server.EndpointDetails resource property to the template. + Adds an AWS::Transfer::Server.EndpointDetails resource property to the template. The virtual private cloud (VPC endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter. .DESCRIPTION Adds an AWS::Transfer::Server.EndpointDetails resource property to the template. - +The virtual private cloud (VPC endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html .PARAMETER AddressAllocationIds + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-addressallocationids UpdateType: Conditional .PARAMETER VpcId + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcid PrimitiveType: String UpdateType: Mutable .PARAMETER VpcEndpointId + The ID of the VPC endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcendpointid PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-subnetids diff --git a/VaporShell/Public/Resource Property Types/Add-VSTransferServerIdentityProviderDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSTransferServerIdentityProviderDetails.ps1 index 70a4349ca..e68ef9aab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSTransferServerIdentityProviderDetails.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSTransferServerIdentityProviderDetails.ps1 @@ -1,21 +1,25 @@ function Add-VSTransferServerIdentityProviderDetails { <# .SYNOPSIS - Adds an AWS::Transfer::Server.IdentityProviderDetails resource property to the template. + Adds an AWS::Transfer::Server.IdentityProviderDetails resource property to the template. This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED. .DESCRIPTION Adds an AWS::Transfer::Server.IdentityProviderDetails resource property to the template. - +This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html .PARAMETER InvocationRole + The InvocationRole parameter provides the type of InvocationRole used to authenticate the user account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-invocationrole PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The Url parameter provides contains the location of the service endpoint used to authenticate users. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 index b29ec6dbc..b155a38c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 @@ -1,36 +1,104 @@ function Add-VSWAFByteMatchSetByteMatchTuple { <# .SYNOPSIS - Adds an AWS::WAF::ByteMatchSet.ByteMatchTuple resource property to the template. + Adds an AWS::WAF::ByteMatchSet.ByteMatchTuple resource property to the template. The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. .DESCRIPTION Adds an AWS::WAF::ByteMatchSet.ByteMatchTuple resource property to the template. - +The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to search, such as a specified header or a query string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch Type: FieldToMatch UpdateType: Mutable .PARAMETER PositionalConstraint + Within the portion of a web request that you want to search for example, in the query string, if any, specify where you want AWS WAF to search. Valid values include the following: +**CONTAINS** +The specified part of the web request must include the value of TargetString, but the location doesn't matter. +**CONTAINS_WORD** +The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore A-Z, a-z, 0-9, or _. In addition, TargetString must be a word, which means one of the following: ++ TargetString exactly matches the value of the specified part of the web request, such as the value of a header. ++ TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore _, for example, BadBot;. ++ TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore _, for example, ;BadBot. ++ TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore _, for example, -BadBot;. +**EXACTLY** +The value of the specified part of the web request must exactly match the value of TargetString. +**STARTS_WITH** +The value of TargetString must appear at the beginning of the specified part of the web request. +**ENDS_WITH** +The value of TargetString must appear at the end of the specified part of the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-positionalconstraint PrimitiveType: String UpdateType: Mutable .PARAMETER TargetString + The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes. +You must specify this property or the TargetStringBase64 property. +Valid values depend on the values that you specified for FieldToMatch: ++ HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header. ++ METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. ++ URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. +If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-targetstring PrimitiveType: String UpdateType: Mutable .PARAMETER TargetStringBase64 + The base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it. +You must specify this property or the TargetString property. +AWS WAF searches for this value in a specific part of web requests, which you define in the FieldToMatch property. +Valid values depend on the Type value in the FieldToMatch property. For example, for a METHOD type, you must specify HTTP methods such as DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-targetstringbase64 PrimitiveType: String UpdateType: Mutable .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. +You can only specify a single type of TextTransformation. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want to perform any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-texttransformation PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 index a9e558895..c6cfc4ce4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFByteMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAF::ByteMatchSet.FieldToMatch resource property to the template. + Adds an AWS::WAF::ByteMatchSet.FieldToMatch resource property to the template. Specifies where in a web request to look for TargetString. .DESCRIPTION Adds an AWS::WAF::ByteMatchSet.FieldToMatch resource property to the template. - +Specifies where in a web request to look for TargetString. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch-data PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 index 0b6e095a4..2e56da3ed 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 @@ -1,21 +1,31 @@ function Add-VSWAFIPSetIPSetDescriptor { <# .SYNOPSIS - Adds an AWS::WAF::IPSet.IPSetDescriptor resource property to the template. + Adds an AWS::WAF::IPSet.IPSetDescriptor resource property to the template. Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. .DESCRIPTION Adds an AWS::WAF::IPSet.IPSetDescriptor resource property to the template. - +Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html .PARAMETER Type + Specify IPV4 or IPV6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html#cfn-waf-ipset-ipsetdescriptors-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + Specify an IPv4 address by using CIDR notation. For example: ++ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. ++ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. +For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. +Specify an IPv6 address by using CIDR notation. For example: ++ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. ++ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html#cfn-waf-ipset-ipsetdescriptors-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 index 99ebbe3a8..60d86cf28 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 @@ -1,36 +1,104 @@ function Add-VSWAFRegionalByteMatchSetByteMatchTuple { <# .SYNOPSIS - Adds an AWS::WAFRegional::ByteMatchSet.ByteMatchTuple resource property to the template. + Adds an AWS::WAFRegional::ByteMatchSet.ByteMatchTuple resource property to the template. The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. .DESCRIPTION Adds an AWS::WAFRegional::ByteMatchSet.ByteMatchTuple resource property to the template. - +The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html .PARAMETER TargetString + The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes. +You must specify this property or the TargetStringBase64 property. +Valid values depend on the values that you specified for FieldToMatch: ++ HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header. ++ METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. ++ URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. +If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-targetstring PrimitiveType: String UpdateType: Mutable .PARAMETER TargetStringBase64 + The base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it. +You must specify this property or the TargetString property. +AWS WAF searches for this value in a specific part of web requests, which you define in the FieldToMatch property. +Valid values depend on the Type value in the FieldToMatch property. For example, for a METHOD type, you must specify HTTP methods such as DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-targetstringbase64 PrimitiveType: String UpdateType: Mutable .PARAMETER PositionalConstraint + Within the portion of a web request that you want to search for example, in the query string, if any, specify where you want AWS WAF to search. Valid values include the following: +**CONTAINS** +The specified part of the web request must include the value of TargetString, but the location doesn't matter. +**CONTAINS_WORD** +The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore A-Z, a-z, 0-9, or _. In addition, TargetString must be a word, which means one of the following: ++ TargetString exactly matches the value of the specified part of the web request, such as the value of a header. ++ TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore _, for example, BadBot;. ++ TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore _, for example, ;BadBot. ++ TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore _, for example, -BadBot;. +**EXACTLY** +The value of the specified part of the web request must exactly match the value of TargetString. +**STARTS_WITH** +The value of TargetString must appear at the beginning of the specified part of the web request. +**ENDS_WITH** +The value of TargetString must appear at the end of the specified part of the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-positionalconstraint PrimitiveType: String UpdateType: Mutable .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. +You can only specify a single type of TextTransformation. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want to perform any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-texttransformation PrimitiveType: String UpdateType: Mutable .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to search, such as a specified header or a query string. + Type: FieldToMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-fieldtomatch UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 index 6aec43d3e..96fbb8d1f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFRegionalByteMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFRegional::ByteMatchSet.FieldToMatch resource property to the template. + Adds an AWS::WAFRegional::ByteMatchSet.FieldToMatch resource property to the template. Specifies where in a web request to look for TargetString. .DESCRIPTION Adds an AWS::WAFRegional::ByteMatchSet.FieldToMatch resource property to the template. - +Specifies where in a web request to look for TargetString. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html#cfn-wafregional-bytematchset-fieldtomatch-type PrimitiveType: String UpdateType: Mutable .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html#cfn-wafregional-bytematchset-fieldtomatch-data PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 index 93e0bf348..5078d388c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 @@ -1,21 +1,25 @@ function Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint { <# .SYNOPSIS - Adds an AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint resource property to the template. + Adds an AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint resource property to the template. The country from which web requests originate that you want AWS WAF to search for. .DESCRIPTION Adds an AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint resource property to the template. - +The country from which web requests originate that you want AWS WAF to search for. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-geomatchset-geomatchconstraint.html .PARAMETER Type + The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-geomatchset-geomatchconstraint.html#cfn-wafregional-geomatchset-geomatchconstraint-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The country that you want AWS WAF to search for. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-geomatchset-geomatchconstraint.html#cfn-wafregional-geomatchset-geomatchconstraint-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 index 303d7d640..c34f6c550 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 @@ -1,21 +1,31 @@ function Add-VSWAFRegionalIPSetIPSetDescriptor { <# .SYNOPSIS - Adds an AWS::WAFRegional::IPSet.IPSetDescriptor resource property to the template. + Adds an AWS::WAFRegional::IPSet.IPSetDescriptor resource property to the template. Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. .DESCRIPTION Adds an AWS::WAFRegional::IPSet.IPSetDescriptor resource property to the template. - +Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html .PARAMETER Type + Specify IPV4 or IPV6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html#cfn-wafregional-ipset-ipsetdescriptor-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value + Specify an IPv4 address by using CIDR notation. For example: ++ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. ++ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. +For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. +Specify an IPv6 address by using CIDR notation. For example: ++ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. ++ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html#cfn-wafregional-ipset-ipsetdescriptor-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRateBasedRulePredicate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRateBasedRulePredicate.ps1 index 416fb6768..4e4ee418c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRateBasedRulePredicate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRateBasedRulePredicate.ps1 @@ -1,26 +1,33 @@ function Add-VSWAFRegionalRateBasedRulePredicate { <# .SYNOPSIS - Adds an AWS::WAFRegional::RateBasedRule.Predicate resource property to the template. + Adds an AWS::WAFRegional::RateBasedRule.Predicate resource property to the template. Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44. .DESCRIPTION Adds an AWS::WAFRegional::RateBasedRule.Predicate resource property to the template. - +Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html .PARAMETER Type + The type of predicate in a Rule, such as ByteMatch or IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html#cfn-wafregional-ratebasedrule-predicate-type PrimitiveType: String UpdateType: Mutable .PARAMETER DataId + A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html#cfn-wafregional-ratebasedrule-predicate-dataid PrimitiveType: String UpdateType: Mutable .PARAMETER Negated + Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. +Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet>. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses *except* 192.0.2.44. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html#cfn-wafregional-ratebasedrule-predicate-negated PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRulePredicate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRulePredicate.ps1 index 4ce51360b..daa9c4c23 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRulePredicate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalRulePredicate.ps1 @@ -1,26 +1,33 @@ function Add-VSWAFRegionalRulePredicate { <# .SYNOPSIS - Adds an AWS::WAFRegional::Rule.Predicate resource property to the template. + Adds an AWS::WAFRegional::Rule.Predicate resource property to the template. Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44. .DESCRIPTION Adds an AWS::WAFRegional::Rule.Predicate resource property to the template. - +Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html .PARAMETER Type + The type of predicate in a Rule, such as ByteMatch or IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-type PrimitiveType: String UpdateType: Mutable .PARAMETER DataId + A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-dataid PrimitiveType: String UpdateType: Mutable .PARAMETER Negated + Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. +Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses *except* 192.0.2.44. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-negated PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetFieldToMatch.ps1 index ff316a3aa..de4813531 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFRegionalSizeConstraintSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFRegional::SizeConstraintSet.FieldToMatch resource property to the template. + Adds an AWS::WAFRegional::SizeConstraintSet.FieldToMatch resource property to the template. Specifies the part of a web request that you want AWS WAF to check for a size constraint, such as a specific header or a query string. .DESCRIPTION Adds an AWS::WAFRegional::SizeConstraintSet.FieldToMatch resource property to the template. - +Specifies the part of a web request that you want AWS WAF to check for a size constraint, such as a specific header or a query string. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html#cfn-wafregional-sizeconstraintset-fieldtomatch-type PrimitiveType: String UpdateType: Mutable .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html#cfn-wafregional-sizeconstraintset-fieldtomatch-data PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 index 52fee781b..bd9517a42 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 @@ -1,31 +1,79 @@ function Add-VSWAFRegionalSizeConstraintSetSizeConstraint { <# .SYNOPSIS - Adds an AWS::WAFRegional::SizeConstraintSet.SizeConstraint resource property to the template. + Adds an AWS::WAFRegional::SizeConstraintSet.SizeConstraint resource property to the template. Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. .DESCRIPTION Adds an AWS::WAFRegional::SizeConstraintSet.SizeConstraint resource property to the template. - +Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html .PARAMETER ComparisonOperator + The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. +**EQ**: Used to test if the Size is equal to the size of the FieldToMatch +**NE**: Used to test if the Size is not equal to the size of the FieldToMatch +**LE**: Used to test if the Size is less than or equal to the size of the FieldToMatch +**LT**: Used to test if the Size is strictly less than the size of the FieldToMatch +**GE**: Used to test if the Size is greater than or equal to the size of the FieldToMatch +**GT**: Used to test if the Size is strictly greater than the size of the FieldToMatch + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER Size + The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. +Valid values for size are 0 - 21474836480 bytes 0 - 20 GB. +If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-size PrimitiveType: Integer UpdateType: Mutable .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. +You can only specify a single type of TextTransformation. +Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. +**NONE** +Specify NONE if you don't want to perform any text transformations. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-texttransformation PrimitiveType: String UpdateType: Mutable .PARAMETER FieldToMatch + Specifies where in a web request to look for the size constraint. + Type: FieldToMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-fieldtomatch UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetFieldToMatch.ps1 index a66c68cc1..124c34216 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFRegionalSqlInjectionMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch resource property to the template. + Adds an AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch resource property to the template. Specifies the part of a web request that you want AWS WAF to search, such as a specific header or a query string. .DESCRIPTION Adds an AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch resource property to the template. - +Specifies the part of a web request that you want AWS WAF to search, such as a specific header or a query string. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html#cfn-wafregional-sqlinjectionmatchset-fieldtomatch-type PrimitiveType: String UpdateType: Mutable .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html#cfn-wafregional-sqlinjectionmatchset-fieldtomatch-data PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 index db3cd3a2a..ae2b70867 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 @@ -1,21 +1,56 @@ function Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple { <# .SYNOPSIS - Adds an AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. + Adds an AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. .DESCRIPTION Adds an AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. - +Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. +You can only specify a single type of TextTransformation. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want to perform any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple-texttransformation PrimitiveType: String UpdateType: Mutable .PARAMETER FieldToMatch + Specifies where in a web request to look for snippets of malicious SQL code. + Type: FieldToMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple-fieldtomatch UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLAction.ps1 index cd50f3ca3..83a24ffd8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLAction.ps1 @@ -1,16 +1,23 @@ function Add-VSWAFRegionalWebACLAction { <# .SYNOPSIS - Adds an AWS::WAFRegional::WebACL.Action resource property to the template. + Adds an AWS::WAFRegional::WebACL.Action resource property to the template. Specifies the action AWS WAF takes when a web request matches or doesn't match all rule conditions. .DESCRIPTION Adds an AWS::WAFRegional::WebACL.Action resource property to the template. - +Specifies the action AWS WAF takes when a web request matches or doesn't match all rule conditions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-action.html .PARAMETER Type + For actions that are associated with a rule, the action that AWS WAF takes when a web request matches all conditions in a rule. +For the default action of a web access control list ACL, the action that AWS WAF takes when a web request doesn't match all conditions in any rule. +Valid settings include the following: ++ ALLOW: AWS WAF allows requests ++ BLOCK: AWS WAF blocks requests ++ COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-action.html#cfn-wafregional-webacl-action-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLRule.ps1 index 2d2e57361..1a2b57d4f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalWebACLRule.ps1 @@ -1,26 +1,38 @@ function Add-VSWAFRegionalWebACLRule { <# .SYNOPSIS - Adds an AWS::WAFRegional::WebACL.Rule resource property to the template. + Adds an AWS::WAFRegional::WebACL.Rule resource property to the template. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: .DESCRIPTION Adds an AWS::WAFRegional::WebACL.Rule resource property to the template. +A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: ++ An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44 + ++ A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot. + +To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html .PARAMETER Action + The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request. + Type: Action Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-action UpdateType: Mutable .PARAMETER Priority + The order in which AWS WAF evaluates the rules in a web ACL. AWS WAF evaluates rules with a lower value before rules with a higher value. The value must be a unique integer. If you have multiple rules in a web ACL, the priority numbers do not need to be consecutive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER RuleId + The ID of an AWS WAF Regional rule to associate with a web ACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-ruleid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetFieldToMatch.ps1 index 9759c0eda..fe550bca8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFRegionalXssMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFRegional::XssMatchSet.FieldToMatch resource property to the template. + Adds an AWS::WAFRegional::XssMatchSet.FieldToMatch resource property to the template. Specifies the part of a web request that you want AWS WAF to search, such as a specific header or a query string. .DESCRIPTION Adds an AWS::WAFRegional::XssMatchSet.FieldToMatch resource property to the template. - +Specifies the part of a web request that you want AWS WAF to search, such as a specific header or a query string. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html#cfn-wafregional-xssmatchset-fieldtomatch-type PrimitiveType: String UpdateType: Mutable .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html#cfn-wafregional-xssmatchset-fieldtomatch-data PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 index 63f674266..465ff1ea1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 @@ -1,21 +1,56 @@ function Add-VSWAFRegionalXssMatchSetXssMatchTuple { <# .SYNOPSIS - Adds an AWS::WAFRegional::XssMatchSet.XssMatchTuple resource property to the template. + Adds an AWS::WAFRegional::XssMatchSet.XssMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. .DESCRIPTION Adds an AWS::WAFRegional::XssMatchSet.XssMatchTuple resource property to the template. - +Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. +You can only specify a single type of TextTransformation. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want to perform any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html#cfn-wafregional-xssmatchset-xssmatchtuple-texttransformation PrimitiveType: String UpdateType: Mutable .PARAMETER FieldToMatch + Specifies where in a web request to look for cross-site scripting attacks. + Type: FieldToMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html#cfn-wafregional-xssmatchset-xssmatchtuple-fieldtomatch UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRulePredicate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRulePredicate.ps1 index a939d71aa..7e23c8845 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRulePredicate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRulePredicate.ps1 @@ -1,26 +1,33 @@ function Add-VSWAFRulePredicate { <# .SYNOPSIS - Adds an AWS::WAF::Rule.Predicate resource property to the template. + Adds an AWS::WAF::Rule.Predicate resource property to the template. Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44. .DESCRIPTION Adds an AWS::WAF::Rule.Predicate resource property to the template. - +Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html .PARAMETER DataId + A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-dataid PrimitiveType: String UpdateType: Mutable .PARAMETER Negated + Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. +Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses *except* 192.0.2.44. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-negated PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Type + The type of predicate in a Rule, such as ByteMatch or IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetFieldToMatch.ps1 index 647876997..acf03988d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFSizeConstraintSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAF::SizeConstraintSet.FieldToMatch resource property to the template. + Adds an AWS::WAF::SizeConstraintSet.FieldToMatch resource property to the template. Specifies the part of a web request that you want AWS WAF to check for a size constraint, such as a specific header or a query string. .DESCRIPTION Adds an AWS::WAF::SizeConstraintSet.FieldToMatch resource property to the template. - +Specifies the part of a web request that you want AWS WAF to check for a size constraint, such as a specific header or a query string. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-data PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 index c9b0ef929..f350205fe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 @@ -1,31 +1,79 @@ function Add-VSWAFSizeConstraintSetSizeConstraint { <# .SYNOPSIS - Adds an AWS::WAF::SizeConstraintSet.SizeConstraint resource property to the template. + Adds an AWS::WAF::SizeConstraintSet.SizeConstraint resource property to the template. Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. .DESCRIPTION Adds an AWS::WAF::SizeConstraintSet.SizeConstraint resource property to the template. - +Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html .PARAMETER ComparisonOperator + The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. +**EQ**: Used to test if the Size is equal to the size of the FieldToMatch +**NE**: Used to test if the Size is not equal to the size of the FieldToMatch +**LE**: Used to test if the Size is less than or equal to the size of the FieldToMatch +**LT**: Used to test if the Size is strictly less than the size of the FieldToMatch +**GE**: Used to test if the Size is greater than or equal to the size of the FieldToMatch +**GT**: Used to test if the Size is strictly greater than the size of the FieldToMatch + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER FieldToMatch + Specifies where in a web request to look for the size constraint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch Type: FieldToMatch UpdateType: Mutable .PARAMETER Size + The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. +Valid values for size are 0 - 21474836480 bytes 0 - 20 GB. +If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-size PrimitiveType: Integer UpdateType: Mutable .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. +You can only specify a single type of TextTransformation. +Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. +**NONE** +Specify NONE if you don't want to perform any text transformations. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-texttransformation PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 index 44b4189b0..c136e5889 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFSqlInjectionMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAF::SqlInjectionMatchSet.FieldToMatch resource property to the template. + Adds an AWS::WAF::SqlInjectionMatchSet.FieldToMatch resource property to the template. Specifies where in a web request to look for TargetString. .DESCRIPTION Adds an AWS::WAF::SqlInjectionMatchSet.FieldToMatch resource property to the template. - +Specifies where in a web request to look for TargetString. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-data PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 index 1888d8c68..76da16727 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 @@ -1,21 +1,56 @@ function Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple { <# .SYNOPSIS - Adds an AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. + Adds an AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. .DESCRIPTION Adds an AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. - +Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html .PARAMETER FieldToMatch + Specifies where in a web request to look for snippets of malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples-fieldtomatch Type: FieldToMatch UpdateType: Mutable .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. +You can only specify a single type of TextTransformation. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want to perform any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples-texttransformation PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLActivatedRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLActivatedRule.ps1 index 8ba914bef..7614b7d69 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLActivatedRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLActivatedRule.ps1 @@ -1,26 +1,39 @@ function Add-VSWAFWebACLActivatedRule { <# .SYNOPSIS - Adds an AWS::WAF::WebACL.ActivatedRule resource property to the template. + Adds an AWS::WAF::WebACL.ActivatedRule resource property to the template. The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT. .DESCRIPTION Adds an AWS::WAF::WebACL.ActivatedRule resource property to the template. +The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT. +To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html .PARAMETER Action + Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: ++ ALLOW: CloudFront responds with the requested object. ++ BLOCK: CloudFront responds with an HTTP 403 Forbidden status code. ++ COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. +ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-action Type: WafAction UpdateType: Mutable .PARAMETER Priority + Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER RuleId + The RuleId for a Rule. You use RuleId to get more information about a Rule, update a Rule, insert a Rule into a WebACL or delete a one from a WebACL, or delete a Rule from AWS WAF. +RuleId is returned by CreateRule and by ListRules. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-ruleid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 index 8ff9ca156..700527dd6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 @@ -1,16 +1,21 @@ function Add-VSWAFWebACLWafAction { <# .SYNOPSIS - Adds an AWS::WAF::WebACL.WafAction resource property to the template. + Adds an AWS::WAF::WebACL.WafAction resource property to the template. For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL. .DESCRIPTION Adds an AWS::WAF::WebACL.WafAction resource property to the template. - +For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-action.html .PARAMETER Type + Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: ++ ALLOW: AWS WAF allows requests ++ BLOCK: AWS WAF blocks requests ++ COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-action.html#cfn-waf-webacl-action-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetFieldToMatch.ps1 index 8f557e08d..c5032a95d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetFieldToMatch.ps1 @@ -1,21 +1,34 @@ function Add-VSWAFXssMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAF::XssMatchSet.FieldToMatch resource property to the template. + Adds an AWS::WAF::XssMatchSet.FieldToMatch resource property to the template. Specifies the part of a web request that you want AWS WAF to search, such as a specific header or a query string. .DESCRIPTION Adds an AWS::WAF::XssMatchSet.FieldToMatch resource property to the template. - +Specifies the part of a web request that you want AWS WAF to search, such as a specific header or a query string. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html .PARAMETER Data + When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. +When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. +If the value of Type is any other value, omit Data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch-data PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: ++ HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. ++ METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. ++ QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. ++ URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ++ BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. ++ SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for SINGLE_QUERY_ARG is 30 characters. ++ ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 index e8064483a..5f69d4624 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 @@ -1,21 +1,56 @@ function Add-VSWAFXssMatchSetXssMatchTuple { <# .SYNOPSIS - Adds an AWS::WAF::XssMatchSet.XssMatchTuple resource property to the template. + Adds an AWS::WAF::XssMatchSet.XssMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. .DESCRIPTION Adds an AWS::WAF::XssMatchSet.XssMatchTuple resource property to the template. - +Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html .PARAMETER FieldToMatch + Specifies where in a web request to look for cross-site scripting attacks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch Type: FieldToMatch UpdateType: Mutable .PARAMETER TextTransformation + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. +You can only specify a single type of TextTransformation. +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want to perform any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html#cfn-waf-xssmatchset-xssmatchtuple-texttransformation PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 index 473ac944b..3fa1c859f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2RuleGroupAndStatementOne { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementone.html#cfn-wafv2-rulegroup-andstatementone-statements UpdateType: Mutable - Type: StatementTwos + Type: List + ItemType: StatementTwo .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2RuleGroupAndStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.StatementTwo" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 index da5a08046..047608053 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2RuleGroupAndStatementTwo { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementtwo.html#cfn-wafv2-rulegroup-andstatementtwo-statements UpdateType: Mutable - Type: StatementThrees + Type: List + ItemType: StatementThree .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2RuleGroupAndStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.StatementThree" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 index c85b1a315..0a9c4e383 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 @@ -28,7 +28,8 @@ function Add-VSWAFv2RuleGroupByteMatchStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .PARAMETER PositionalConstraint Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-positionalconstraint @@ -42,7 +43,7 @@ function Add-VSWAFv2RuleGroupByteMatchStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -64,11 +65,20 @@ function Add-VSWAFv2RuleGroupByteMatchStatement { } })] $SearchStringBase64, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 index 5058da810..751b20af0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 @@ -13,37 +13,37 @@ function Add-VSWAFv2RuleGroupFieldToMatch { .PARAMETER SingleHeader Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singleheader UpdateType: Mutable - Type: SingleHeader + PrimitiveType: Json .PARAMETER SingleQueryArgument Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singlequeryargument UpdateType: Mutable - Type: SingleQueryArgument + PrimitiveType: Json .PARAMETER AllQueryArguments Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-allqueryarguments UpdateType: Mutable - Type: AllQueryArguments + PrimitiveType: Json .PARAMETER UriPath Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-uripath UpdateType: Mutable - Type: UriPath + PrimitiveType: Json .PARAMETER QueryString Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-querystring UpdateType: Mutable - Type: QueryString + PrimitiveType: Json .PARAMETER Body Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-body UpdateType: Mutable - Type: Body + PrimitiveType: Json .PARAMETER Method Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-method UpdateType: Mutable - Type: Method + PrimitiveType: Json .FUNCTIONALITY Vaporshell @@ -53,18 +53,81 @@ function Add-VSWAFv2RuleGroupFieldToMatch { Param ( [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $SingleHeader, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $SingleQueryArgument, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $AllQueryArguments, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $UriPath, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $QueryString, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Body, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Method ) Begin { @@ -74,6 +137,104 @@ function Add-VSWAFv2RuleGroupFieldToMatch { Process { foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { switch ($key) { + SingleHeader { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + SingleQueryArgument { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + AllQueryArguments { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + UriPath { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + QueryString { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Body { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Method { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } Default { $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key } diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 index 41e1149db..6caa84660 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2RuleGroupGeoMatchStatement { .PARAMETER CountryCodes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-countrycodes UpdateType: Mutable - Type: CountryCodes + Type: List + PrimitiveItemType: String .FUNCTIONALITY Vaporshell diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 index 718bc45b8..8de4f309c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2RuleGroupIPSetReferenceStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 index f7ffbf1e7..e5ce2ac3d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2RuleGroupNotStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $Statement ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 index 0e0d1a27f..f53b0714c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2RuleGroupNotStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $Statement ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 index 80d1d241e..8b55a33f0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2RuleGroupOrStatementOne { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementone.html#cfn-wafv2-rulegroup-orstatementone-statements UpdateType: Mutable - Type: StatementTwos + Type: List + ItemType: StatementTwo .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2RuleGroupOrStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.StatementTwo" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 index 77c7b0fbe..e2a29eda7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2RuleGroupOrStatementTwo { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementtwo.html#cfn-wafv2-rulegroup-orstatementtwo-statements UpdateType: Mutable - Type: StatementThrees + Type: List + ItemType: StatementThree .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2RuleGroupOrStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.StatementThree" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 index c3e2c0bcb..f76c42aea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 @@ -32,7 +32,7 @@ function Add-VSWAFv2RuleGroupRateBasedStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +43,7 @@ function Add-VSWAFv2RuleGroupRateBasedStatementOne { } })] $Limit, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 index 34771d8cd..33b6d6e0a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 @@ -32,7 +32,7 @@ function Add-VSWAFv2RuleGroupRateBasedStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +43,7 @@ function Add-VSWAFv2RuleGroupRateBasedStatementTwo { } })] $Limit, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 index d001dbf7d..af053d3e2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 @@ -23,7 +23,8 @@ function Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -32,7 +33,7 @@ function Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,9 +44,18 @@ function Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement { } })] $Arn, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 index a02f2d849..066166804 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 @@ -42,7 +42,7 @@ function Add-VSWAFv2RuleGroupRule { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -53,7 +53,7 @@ function Add-VSWAFv2RuleGroupRule { } })] $Name, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -64,11 +64,11 @@ function Add-VSWAFv2RuleGroupRule { } })] $Priority, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $Statement, [parameter(Mandatory = $false)] $Action, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $VisibilityConfig ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 index f2e6125ed..817cc232b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 @@ -13,17 +13,17 @@ function Add-VSWAFv2RuleGroupRuleAction { .PARAMETER Allow Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-allow UpdateType: Mutable - Type: AllowAction + PrimitiveType: Json .PARAMETER Block Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-block UpdateType: Mutable - Type: BlockAction + PrimitiveType: Json .PARAMETER Count Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-count UpdateType: Mutable - Type: CountAction + PrimitiveType: Json .FUNCTIONALITY Vaporshell @@ -33,10 +33,37 @@ function Add-VSWAFv2RuleGroupRuleAction { Param ( [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Allow, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Block, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Count ) Begin { @@ -46,6 +73,48 @@ function Add-VSWAFv2RuleGroupRuleAction { Process { foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { switch ($key) { + Allow { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Block { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Count { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } Default { $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key } diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 index a528f9a43..509490394 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 @@ -28,7 +28,8 @@ function Add-VSWAFv2RuleGroupSizeConstraintStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -37,9 +38,9 @@ function Add-VSWAFv2RuleGroupSizeConstraintStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -50,7 +51,7 @@ function Add-VSWAFv2RuleGroupSizeConstraintStatement { } })] $ComparisonOperator, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -61,7 +62,16 @@ function Add-VSWAFv2RuleGroupSizeConstraintStatement { } })] $Size, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 index 1e95f079b..5d3e46dd8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 @@ -18,7 +18,8 @@ function Add-VSWAFv2RuleGroupSqliMatchStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -27,9 +28,18 @@ function Add-VSWAFv2RuleGroupSqliMatchStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 index 4732626c9..8d945bbc6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 @@ -27,7 +27,7 @@ function Add-VSWAFv2RuleGroupTextTransformation { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -38,7 +38,7 @@ function Add-VSWAFv2RuleGroupTextTransformation { } })] $Priority, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 index 1c38df6a9..87e38fd54 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 @@ -32,7 +32,7 @@ function Add-VSWAFv2RuleGroupVisibilityConfig { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Boolean","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +43,7 @@ function Add-VSWAFv2RuleGroupVisibilityConfig { } })] $SampledRequestsEnabled, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Boolean","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -54,7 +54,7 @@ function Add-VSWAFv2RuleGroupVisibilityConfig { } })] $CloudWatchMetricsEnabled, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 index 5cb5ef408..0c758beb5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 @@ -18,7 +18,8 @@ function Add-VSWAFv2RuleGroupXssMatchStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -27,9 +28,18 @@ function Add-VSWAFv2RuleGroupXssMatchStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 index 09a29978e..85e763d9d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2WebACLAndStatementOne { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementone.html#cfn-wafv2-webacl-andstatementone-statements UpdateType: Mutable - Type: StatementTwos + Type: List + ItemType: StatementTwo .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2WebACLAndStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.StatementTwo" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 index fa9b2bcb3..3519ad457 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2WebACLAndStatementTwo { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementtwo.html#cfn-wafv2-webacl-andstatementtwo-statements UpdateType: Mutable - Type: StatementThrees + Type: List + ItemType: StatementThree .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2WebACLAndStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.StatementThree" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 index bb78c94b2..b7499e8f3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 @@ -28,7 +28,8 @@ function Add-VSWAFv2WebACLByteMatchStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .PARAMETER PositionalConstraint Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-positionalconstraint @@ -42,7 +43,7 @@ function Add-VSWAFv2WebACLByteMatchStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -64,11 +65,20 @@ function Add-VSWAFv2WebACLByteMatchStatement { } })] $SearchStringBase64, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 index d22a3aaa1..0f16fb5ae 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 @@ -13,12 +13,12 @@ function Add-VSWAFv2WebACLDefaultAction { .PARAMETER Allow Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-allow UpdateType: Mutable - Type: AllowAction + PrimitiveType: Json .PARAMETER Block Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-block UpdateType: Mutable - Type: BlockAction + PrimitiveType: Json .FUNCTIONALITY Vaporshell @@ -28,8 +28,26 @@ function Add-VSWAFv2WebACLDefaultAction { Param ( [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Allow, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Block ) Begin { @@ -39,6 +57,34 @@ function Add-VSWAFv2WebACLDefaultAction { Process { foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { switch ($key) { + Allow { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Block { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } Default { $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key } diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 index d7d34281e..9ad7a673c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2WebACLExcludedRule { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 index 29f3326be..1195a957c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 @@ -13,37 +13,37 @@ function Add-VSWAFv2WebACLFieldToMatch { .PARAMETER SingleHeader Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singleheader UpdateType: Mutable - Type: SingleHeader + PrimitiveType: Json .PARAMETER SingleQueryArgument Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singlequeryargument UpdateType: Mutable - Type: SingleQueryArgument + PrimitiveType: Json .PARAMETER AllQueryArguments Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-allqueryarguments UpdateType: Mutable - Type: AllQueryArguments + PrimitiveType: Json .PARAMETER UriPath Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-uripath UpdateType: Mutable - Type: UriPath + PrimitiveType: Json .PARAMETER QueryString Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-querystring UpdateType: Mutable - Type: QueryString + PrimitiveType: Json .PARAMETER Body Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-body UpdateType: Mutable - Type: Body + PrimitiveType: Json .PARAMETER Method Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-method UpdateType: Mutable - Type: Method + PrimitiveType: Json .FUNCTIONALITY Vaporshell @@ -53,18 +53,81 @@ function Add-VSWAFv2WebACLFieldToMatch { Param ( [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $SingleHeader, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $SingleQueryArgument, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $AllQueryArguments, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $UriPath, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $QueryString, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Body, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Method ) Begin { @@ -74,6 +137,104 @@ function Add-VSWAFv2WebACLFieldToMatch { Process { foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { switch ($key) { + SingleHeader { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + SingleQueryArgument { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + AllQueryArguments { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + UriPath { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + QueryString { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Body { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Method { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } Default { $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key } diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 index 479bb5b3e..f4197c108 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2WebACLGeoMatchStatement { .PARAMETER CountryCodes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html#cfn-wafv2-webacl-geomatchstatement-countrycodes UpdateType: Mutable - Type: CountryCodes + Type: List + PrimitiveItemType: String .FUNCTIONALITY Vaporshell diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 index 1bd1d9405..c264a6a2d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2WebACLIPSetReferenceStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 index 88c0ae677..62f7b6bfa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 @@ -23,7 +23,8 @@ function Add-VSWAFv2WebACLManagedRuleGroupStatement { .PARAMETER ExcludedRules Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-excludedrules UpdateType: Mutable - Type: ExcludedRules + Type: List + ItemType: ExcludedRule .FUNCTIONALITY Vaporshell @@ -32,7 +33,7 @@ function Add-VSWAFv2WebACLManagedRuleGroupStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +44,7 @@ function Add-VSWAFv2WebACLManagedRuleGroupStatement { } })] $Name, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -55,6 +56,15 @@ function Add-VSWAFv2WebACLManagedRuleGroupStatement { })] $VendorName, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.ExcludedRule" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $ExcludedRules ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 index f90e0a47b..2b6e6a081 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2WebACLNotStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $Statement ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 index 51277c97f..5a9b01410 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 @@ -22,7 +22,7 @@ function Add-VSWAFv2WebACLNotStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $Statement ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 index 177a29cd5..b8ad4de57 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2WebACLOrStatementOne { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementone.html#cfn-wafv2-webacl-orstatementone-statements UpdateType: Mutable - Type: StatementTwos + Type: List + ItemType: StatementTwo .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2WebACLOrStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.StatementTwo" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 index c026c685e..6651d8655 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 @@ -13,7 +13,8 @@ function Add-VSWAFv2WebACLOrStatementTwo { .PARAMETER Statements Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementtwo.html#cfn-wafv2-webacl-orstatementtwo-statements UpdateType: Mutable - Type: StatementThrees + Type: List + ItemType: StatementThree .FUNCTIONALITY Vaporshell @@ -22,7 +23,16 @@ function Add-VSWAFv2WebACLOrStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.StatementThree" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Statements ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 index d6d9902db..96b6cc58e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 @@ -13,12 +13,12 @@ function Add-VSWAFv2WebACLOverrideAction { .PARAMETER Count Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-count UpdateType: Mutable - Type: CountAction + PrimitiveType: Json .PARAMETER None Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-none UpdateType: Mutable - Type: NoneAction + PrimitiveType: Json .FUNCTIONALITY Vaporshell @@ -28,8 +28,26 @@ function Add-VSWAFv2WebACLOverrideAction { Param ( [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Count, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $None ) Begin { @@ -39,6 +57,34 @@ function Add-VSWAFv2WebACLOverrideAction { Process { foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { switch ($key) { + Count { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + None { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } Default { $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key } diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 index 9fcd6154a..1e08eec13 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 @@ -32,7 +32,7 @@ function Add-VSWAFv2WebACLRateBasedStatementOne { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +43,7 @@ function Add-VSWAFv2WebACLRateBasedStatementOne { } })] $Limit, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 index 75585da31..af38865c9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 @@ -32,7 +32,7 @@ function Add-VSWAFv2WebACLRateBasedStatementTwo { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +43,7 @@ function Add-VSWAFv2WebACLRateBasedStatementTwo { } })] $Limit, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 index 59a819e37..a2b629a4f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 @@ -23,7 +23,8 @@ function Add-VSWAFv2WebACLRegexPatternSetReferenceStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -32,7 +33,7 @@ function Add-VSWAFv2WebACLRegexPatternSetReferenceStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,9 +44,18 @@ function Add-VSWAFv2WebACLRegexPatternSetReferenceStatement { } })] $Arn, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 index 14167ad30..a868c5d64 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 @@ -47,7 +47,7 @@ function Add-VSWAFv2WebACLRule { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -58,7 +58,7 @@ function Add-VSWAFv2WebACLRule { } })] $Name, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -69,13 +69,13 @@ function Add-VSWAFv2WebACLRule { } })] $Priority, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $Statement, [parameter(Mandatory = $false)] $Action, [parameter(Mandatory = $false)] $OverrideAction, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $VisibilityConfig ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 index 07443af47..ab830d7c6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 @@ -13,17 +13,17 @@ function Add-VSWAFv2WebACLRuleAction { .PARAMETER Allow Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-allow UpdateType: Mutable - Type: AllowAction + PrimitiveType: Json .PARAMETER Block Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-block UpdateType: Mutable - Type: BlockAction + PrimitiveType: Json .PARAMETER Count Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-count UpdateType: Mutable - Type: CountAction + PrimitiveType: Json .FUNCTIONALITY Vaporshell @@ -33,10 +33,37 @@ function Add-VSWAFv2WebACLRuleAction { Param ( [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Allow, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Block, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Count ) Begin { @@ -46,6 +73,48 @@ function Add-VSWAFv2WebACLRuleAction { Process { foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { switch ($key) { + Allow { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Block { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Count { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } Default { $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key } diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 index da7d6305b..7ecc57c42 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 @@ -18,7 +18,8 @@ function Add-VSWAFv2WebACLRuleGroupReferenceStatement { .PARAMETER ExcludedRules Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-excludedrules UpdateType: Mutable - Type: ExcludedRules + Type: List + ItemType: ExcludedRule .FUNCTIONALITY Vaporshell @@ -27,7 +28,7 @@ function Add-VSWAFv2WebACLRuleGroupReferenceStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -39,6 +40,15 @@ function Add-VSWAFv2WebACLRuleGroupReferenceStatement { })] $Arn, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.ExcludedRule" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $ExcludedRules ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 index 80ee96db0..5aa063509 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 @@ -28,7 +28,8 @@ function Add-VSWAFv2WebACLSizeConstraintStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -37,9 +38,9 @@ function Add-VSWAFv2WebACLSizeConstraintStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -50,7 +51,7 @@ function Add-VSWAFv2WebACLSizeConstraintStatement { } })] $ComparisonOperator, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -61,7 +62,16 @@ function Add-VSWAFv2WebACLSizeConstraintStatement { } })] $Size, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 index 9de92266c..5be1e7ed2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 @@ -18,7 +18,8 @@ function Add-VSWAFv2WebACLSqliMatchStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -27,9 +28,18 @@ function Add-VSWAFv2WebACLSqliMatchStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 index ff130e9e7..e8ab6b088 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 @@ -27,7 +27,7 @@ function Add-VSWAFv2WebACLTextTransformation { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Int32","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -38,7 +38,7 @@ function Add-VSWAFv2WebACLTextTransformation { } })] $Priority, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 index 88a3b53d0..468614623 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 @@ -32,7 +32,7 @@ function Add-VSWAFv2WebACLVisibilityConfig { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Boolean","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -43,7 +43,7 @@ function Add-VSWAFv2WebACLVisibilityConfig { } })] $SampledRequestsEnabled, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.Boolean","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { @@ -54,7 +54,7 @@ function Add-VSWAFv2WebACLVisibilityConfig { } })] $CloudWatchMetricsEnabled, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 index cfb4e97a0..80c5d519a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 @@ -18,7 +18,8 @@ function Add-VSWAFv2WebACLXssMatchStatement { .PARAMETER TextTransformations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-texttransformations UpdateType: Mutable - Type: TextTransformations + Type: List + ItemType: TextTransformation .FUNCTIONALITY Vaporshell @@ -27,9 +28,18 @@ function Add-VSWAFv2WebACLXssMatchStatement { [cmdletbinding()] Param ( - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] $FieldToMatch, - [parameter(Mandatory = $false)] + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.TextTransformation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $TextTransformations ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 index 6195bc12c..ed07099bf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 @@ -1,36 +1,46 @@ function Add-VSWorkSpacesWorkspaceWorkspaceProperties { <# .SYNOPSIS - Adds an AWS::WorkSpaces::Workspace.WorkspaceProperties resource property to the template. + Adds an AWS::WorkSpaces::Workspace.WorkspaceProperties resource property to the template. Information about a WorkSpace. .DESCRIPTION Adds an AWS::WorkSpaces::Workspace.WorkspaceProperties resource property to the template. - +Information about a WorkSpace. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html .PARAMETER ComputeTypeName + The compute type. For more information, see Amazon WorkSpaces Bundles: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-computetypename PrimitiveType: String UpdateType: Mutable .PARAMETER RootVolumeSizeGib + The size of the root volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-rootvolumesizegib PrimitiveType: Integer UpdateType: Mutable .PARAMETER RunningMode + The running mode. For more information, see Manage the WorkSpace Running Mode: https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmode PrimitiveType: String UpdateType: Mutable .PARAMETER RunningModeAutoStopTimeoutInMinutes + The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes PrimitiveType: Integer UpdateType: Mutable .PARAMETER UserVolumeSizeGib + The size of the user storage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-uservolumesizegib PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 b/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 index 1d7fae9ec..2dded82e7 100644 --- a/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 @@ -1,10 +1,10 @@ function New-VSAlexaASKSkill { <# .SYNOPSIS - Adds an Alexa::ASK::Skill resource to the template. + Adds an Alexa::ASK::Skill resource to the template. The Alexa::ASK::Skill resource creates an Alexa skill that enables customers to access new abilities. For more information about developing a skill, see the Build Skills with the Alexa Skills Kit developer documentation: https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html. .DESCRIPTION - Adds an Alexa::ASK::Skill resource to the template. + Adds an Alexa::ASK::Skill resource to the template. The Alexa::ASK::Skill resource creates an Alexa skill that enables customers to access new abilities. For more information about developing a skill, see the Build Skills with the Alexa Skills Kit developer documentation: https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html @@ -13,16 +13,22 @@ function New-VSAlexaASKSkill { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AuthenticationConfiguration + Login with Amazon LWA configuration used to authenticate with the Alexa service. Only Login with Amazon clients created through the Amazon Developer Console: https://developer.amazon.com/lwa/sp/overview.html are supported. The client ID, client secret, and refresh token are required. + Type: AuthenticationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-authenticationconfiguration UpdateType: Mutable .PARAMETER VendorId + The vendor ID associated with the Amazon developer account that will host the skill. Details for retrieving the vendor ID are in How to get your vendor ID: https://github.com/alexa/alexa-smarthome/wiki/How-to-get-your-vendor-ID. The provided LWA credentials must be linked to the developer account associated with this vendor ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-vendorid PrimitiveType: String UpdateType: Immutable .PARAMETER SkillPackage + Configuration for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. For more information about the skill package format, see the Skill Package API Reference: https://developer.amazon.com/docs/smapi/skill-package-api-reference.html#skill-package-format. + Type: SkillPackage Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-skillpackage UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 index 7361f871a..3c55b8554 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 @@ -1,10 +1,40 @@ function New-VSAmazonMQBroker { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Broker resource to the template. + Adds an AWS::AmazonMQ::Broker resource to the template. A *broker* is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. .DESCRIPTION - Adds an AWS::AmazonMQ::Broker resource to the template. + Adds an AWS::AmazonMQ::Broker resource to the template. A *broker* is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. + +The AWS::AmazonMQ::Broker resource lets you create Amazon MQ brokers, add configuration changes or modify users for the specified broker, return information about the specified broker, and delete the specified broker. For more information, see Amazon MQ Basic Elements: https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-basic-elements.html in the *Amazon MQ Developer Guide*. + ++ ec2:CreateNetworkInterface + +This permission is required to allow Amazon MQ to create an elastic network interface (ENI on behalf of your account. + ++ ec2:CreateNetworkInterfacePermission + +This permission is required to attach the ENI to the broker instance. + ++ ec2:DeleteNetworkInterface + ++ ec2:DeleteNetworkInterfacePermission + ++ ec2:DetachNetworkInterface + ++ ec2:DescribeInternetGateways + ++ ec2:DescribeNetworkInterfaces + ++ ec2:DescribeNetworkInterfacePermissions + ++ ec2:DescribeRouteTables + ++ ec2:DescribeSecurityGroups + ++ ec2:DescribeSubnets + ++ ec2:DescribeVpcs .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html @@ -13,6 +43,8 @@ function New-VSAmazonMQBroker { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecurityGroups + The list of rules 1 minimum, 125 maximum that authorize connections to brokers. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups @@ -24,73 +56,103 @@ function New-VSAmazonMQBroker { UpdateType: Immutable .PARAMETER EngineVersion + The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion PrimitiveType: String UpdateType: Mutable .PARAMETER Configuration + A list of information about the configuration. + Type: ConfigurationId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration UpdateType: Mutable .PARAMETER MaintenanceWindowStartTime + The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.. + Type: MaintenanceWindow Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime UpdateType: Immutable .PARAMETER HostInstanceType + The broker's instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype PrimitiveType: String UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade + Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Users + The list of ActiveMQ users persons or applications who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes - . _ ~. This value must be 2-100 characters long. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users ItemType: User UpdateType: Mutable .PARAMETER Logs + Enables Amazon CloudWatch logging for brokers. + Type: LogList Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs UpdateType: Mutable .PARAMETER SubnetIds + The list of groups 2 maximum that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet for example, the default subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids UpdateType: Immutable .PARAMETER BrokerName + The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername PrimitiveType: String UpdateType: Immutable .PARAMETER DeploymentMode + The deployment mode of the broker. Available values: ++ SINGLE_INSTANCE ++ ACTIVE_STANDBY_MULTI_AZ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode PrimitiveType: String UpdateType: Immutable .PARAMETER EngineType + The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype PrimitiveType: String UpdateType: Immutable .PARAMETER PubliclyAccessible + Enables connections from applications outside of the VPC that hosts the broker's subnets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible PrimitiveType: Boolean UpdateType: Immutable .PARAMETER EncryptionOptions + Encryption options for the broker. + Type: EncryptionOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions UpdateType: Immutable .PARAMETER Tags + An array of key-value pairs. For more information, see Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html in the *AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags ItemType: TagsEntry diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 index 57185e19a..4ce0f0deb 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 @@ -1,10 +1,10 @@ function New-VSAmazonMQConfiguration { <# .SYNOPSIS - Adds an AWS::AmazonMQ::Configuration resource to the template. + Adds an AWS::AmazonMQ::Configuration resource to the template. Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version. .DESCRIPTION - Adds an AWS::AmazonMQ::Configuration resource to the template. + Adds an AWS::AmazonMQ::Configuration resource to the template. Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html @@ -13,32 +13,44 @@ function New-VSAmazonMQConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EngineVersion + The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-engineversion PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of the configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-description PrimitiveType: String UpdateType: Mutable .PARAMETER EngineType + The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-enginetype PrimitiveType: String UpdateType: Immutable .PARAMETER Data + The base64-encoded XML configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-data PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + Create tags when creating the configuration. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-tags ItemType: TagsEntry UpdateType: Mutable .PARAMETER Name + The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes - . _ ~. This value must be 1-150 characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 index 8754e0b05..9a3e02a45 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSAmazonMQConfigurationAssociation { <# .SYNOPSIS - Adds an AWS::AmazonMQ::ConfigurationAssociation resource to the template. + Adds an AWS::AmazonMQ::ConfigurationAssociation resource to the template. Use the AWS CloudFormation AWS::AmazonMQ::ConfigurationAssociation resource to associate a configuration with a broker, or return information about the specified ConfigurationAssociation. Only use one per broker, and don't use a configuration on the broker resource if you have associated a configuration with that broker. .DESCRIPTION - Adds an AWS::AmazonMQ::ConfigurationAssociation resource to the template. + Adds an AWS::AmazonMQ::ConfigurationAssociation resource to the template. Use the AWS CloudFormation AWS::AmazonMQ::ConfigurationAssociation resource to associate a configuration with a broker, or return information about the specified ConfigurationAssociation. Only use one per broker, and don't use a configuration on the broker resource if you have associated a configuration with that broker. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html @@ -13,11 +13,15 @@ function New-VSAmazonMQConfigurationAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Broker + The broker to associate with a configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-broker PrimitiveType: String UpdateType: Immutable .PARAMETER Configuration + The configuration to associate with a broker. + Type: ConfigurationId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-configuration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 index 29c33ace8..68a94335e 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 @@ -1,10 +1,10 @@ function New-VSAmplifyApp { <# .SYNOPSIS - Adds an AWS::Amplify::App resource to the template. + Adds an AWS::Amplify::App resource to the template. The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches. .DESCRIPTION - Adds an AWS::Amplify::App resource to the template. + Adds an AWS::Amplify::App resource to the template. The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html @@ -13,64 +13,88 @@ function New-VSAmplifyApp { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoBranchCreationConfig + Sets the configuration for your automatic branch creation. + Type: AutoBranchCreationConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig UpdateType: Mutable .PARAMETER OauthToken + OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken PrimitiveType: String UpdateType: Mutable .PARAMETER Repository + Repository for an Amplify App + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository PrimitiveType: String UpdateType: Mutable .PARAMETER Description + Description for an Amplify App + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description PrimitiveType: String UpdateType: Mutable .PARAMETER EnvironmentVariables + Environment variables map for an Amplify App. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables ItemType: EnvironmentVariable UpdateType: Mutable .PARAMETER AccessToken + Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken PrimitiveType: String UpdateType: Mutable .PARAMETER BuildSpec + BuildSpec for an Amplify App + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec PrimitiveType: String UpdateType: Mutable .PARAMETER CustomRules + Custom rewrite / redirect rules for an Amplify App. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules ItemType: CustomRule UpdateType: Mutable .PARAMETER BasicAuthConfig + Credentials for Basic Authorization for an Amplify App. + Type: BasicAuthConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig UpdateType: Mutable .PARAMETER Tags + Tag for an Amplify App + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + Name for the Amplify App + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name PrimitiveType: String UpdateType: Mutable .PARAMETER IAMServiceRole + IAM service role ARN for the Amplify App. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 index 181a19f1c..069e44e70 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 @@ -1,10 +1,10 @@ function New-VSAmplifyBranch { <# .SYNOPSIS - Adds an AWS::Amplify::Branch resource to the template. + Adds an AWS::Amplify::Branch resource to the template. The AWS::Amplify::Branch resource creates a new branch within an app. .DESCRIPTION - Adds an AWS::Amplify::Branch resource to the template. + Adds an AWS::Amplify::Branch resource to the template. The AWS::Amplify::Branch resource creates a new branch within an app. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html @@ -13,57 +13,79 @@ function New-VSAmplifyBranch { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Description for the branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description PrimitiveType: String UpdateType: Mutable .PARAMETER EnvironmentVariables + Environment Variables for the branch. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables ItemType: EnvironmentVariable UpdateType: Mutable .PARAMETER AppId + Unique Id for an Amplify App. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid PrimitiveType: String UpdateType: Immutable .PARAMETER PullRequestEnvironmentName + Name for a branch, part of an Amplify App. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname PrimitiveType: String UpdateType: Mutable .PARAMETER EnablePullRequestPreview + Name for a branch, part of an Amplify App. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EnableAutoBuild + Enables auto building for the branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild PrimitiveType: Boolean UpdateType: Mutable .PARAMETER BuildSpec + BuildSpec for the branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec PrimitiveType: String UpdateType: Mutable .PARAMETER Stage + Stage for the branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage PrimitiveType: String UpdateType: Mutable .PARAMETER BranchName + Name for the branch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname PrimitiveType: String UpdateType: Immutable .PARAMETER BasicAuthConfig + Basic Authorization credentials for a branch, part of an Amplify App. + Type: BasicAuthConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig UpdateType: Mutable .PARAMETER Tags + Tag for the branch. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 index 01186adf6..b3e55200d 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 @@ -1,10 +1,10 @@ function New-VSAmplifyDomain { <# .SYNOPSIS - Adds an AWS::Amplify::Domain resource to the template. + Adds an AWS::Amplify::Domain resource to the template. The AWS::Amplify::Domain resource allows you to connect a custom domain to your app. .DESCRIPTION - Adds an AWS::Amplify::Domain resource to the template. + Adds an AWS::Amplify::Domain resource to the template. The AWS::Amplify::Domain resource allows you to connect a custom domain to your app. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html @@ -13,17 +13,23 @@ function New-VSAmplifyDomain { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SubDomainSettings + Setting structure for the Subdomain. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings ItemType: SubDomainSetting UpdateType: Mutable .PARAMETER AppId + Unique Id for an Amplify App. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid PrimitiveType: String UpdateType: Immutable .PARAMETER DomainName + Domain name for the Domain Association. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 index 6b345fb10..bc4c7e5ad 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 @@ -1,10 +1,16 @@ function New-VSApiGatewayAccount { <# .SYNOPSIS - Adds an AWS::ApiGateway::Account resource to the template. + Adds an AWS::ApiGateway::Account resource to the template. The AWS::ApiGateway::Account resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. .DESCRIPTION - Adds an AWS::ApiGateway::Account resource to the template. + Adds an AWS::ApiGateway::Account resource to the template. The AWS::ApiGateway::Account resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. + +**Important** + +If an API Gateway resource has never been created in your AWS account, you must add a dependency on another API Gateway resource, such as an AWS::ApiGateway::RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html or AWS::ApiGateway::ApiKey: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html resource. + +If an API Gateway resource has been created in your AWS account, no dependency is required (even if the resource was deleted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html @@ -13,6 +19,8 @@ function New-VSApiGatewayAccount { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CloudWatchRoleArn + The Amazon Resource Name ARN of an IAM role that has write access to CloudWatch Logs in your account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 index 4cf5b5c61..2e0318541 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayApiKey { <# .SYNOPSIS - Adds an AWS::ApiGateway::ApiKey resource to the template. + Adds an AWS::ApiGateway::ApiKey resource to the template. The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key. .DESCRIPTION - Adds an AWS::ApiGateway::ApiKey resource to the template. + Adds an AWS::ApiGateway::ApiKey resource to the template. The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html @@ -13,31 +13,44 @@ function New-VSApiGatewayApiKey { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CustomerId + An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the purpose of the API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Indicates whether the API key can be used by clients. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER GenerateDistinctId + Specifies whether the key identifier is distinct from the created API key value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Name + A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name PrimitiveType: String UpdateType: Immutable .PARAMETER StageKeys + A list of stages to associate with this API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys DuplicatesAllowed: False ItemType: StageKey @@ -45,6 +58,8 @@ function New-VSApiGatewayApiKey { UpdateType: Mutable .PARAMETER Tags + + apikey:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/apikey-create/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags DuplicatesAllowed: True ItemType: Tag @@ -52,6 +67,8 @@ function New-VSApiGatewayApiKey { UpdateType: Mutable .PARAMETER Value + The value of the API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 index 04a4ecc4d..0d9864097 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayAuthorizer { <# .SYNOPSIS - Adds an AWS::ApiGateway::Authorizer resource to the template. + Adds an AWS::ApiGateway::Authorizer resource to the template. The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. .DESCRIPTION - Adds an AWS::ApiGateway::Authorizer resource to the template. + Adds an AWS::ApiGateway::Authorizer resource to the template. The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html @@ -13,41 +13,59 @@ function New-VSApiGatewayAuthorizer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AuthType + An optional customer-defined field that's used in OpenApi imports and exports without functional impact. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerCredentials + The credentials that are required for the authorizer. To specify an IAM role that API Gateway assumes, specify the role's Amazon Resource Name ARN. To use resource-based permissions on the Lambda function, specify null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerResultTtlInSeconds + The time-to-live TTL period, in seconds, that specifies how long API Gateway caches authorizer results. If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER AuthorizerUri + The authorizer's Uniform Resource Identifier URI. If you specify TOKEN for the authorizer's Type property, specify a Lambda function URI that has the form arn:aws:apigateway:region:lambda:path/path. The path usually has the form /2015-03-31/functions/*LambdaFunctionARN*/invocations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri PrimitiveType: String UpdateType: Mutable .PARAMETER IdentitySource + The source of the identity in an incoming request. +If you specify TOKEN or COGNITO_USER_POOLS for the Type property, specify a header mapping expression using the form method.request.header.name, where *name* is the name of a custom authorization header that clients submit as part of their requests. +If you specify REQUEST for the Type property, specify a comma-separated string of one or more mapping expressions of the specified request parameter using the form method.request.parameter.name. For supported parameter types, see Configure Lambda Authorizer Using the API Gateway Console: https://docs.aws.amazon.com/apigateway/latest/developerguide/configure-api-gateway-lambda-authorization-with-console.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource PrimitiveType: String UpdateType: Mutable .PARAMETER IdentityValidationExpression + A validation expression for the incoming identity. If you specify TOKEN for the authorizer's Type property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 unauthorized request error code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the authorizer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name PrimitiveType: String UpdateType: Mutable .PARAMETER ProviderARNs + A list of the Amazon Cognito user pool Amazon Resource Names ARNs to associate with this authorizer. For more information, see Use Amazon Cognito User Pools: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns DuplicatesAllowed: False PrimitiveItemType: String @@ -55,11 +73,18 @@ function New-VSApiGatewayAuthorizer { UpdateType: Mutable .PARAMETER RestApiId + The ID of the RestApi resource that API Gateway creates the authorizer in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of authorizer. Valid values include: ++ TOKEN: A custom authorizer that uses a Lambda function. ++ COGNITO_USER_POOLS: An authorizer that uses Amazon Cognito user pools. ++ REQUEST: An authorizer that uses a Lambda function using incoming request parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 index 7a68db301..7ac097f53 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayBasePathMapping { <# .SYNOPSIS - Adds an AWS::ApiGateway::BasePathMapping resource to the template. + Adds an AWS::ApiGateway::BasePathMapping resource to the template. The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL. .DESCRIPTION - Adds an AWS::ApiGateway::BasePathMapping resource to the template. + Adds an AWS::ApiGateway::BasePathMapping resource to the template. The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html @@ -13,21 +13,29 @@ function New-VSApiGatewayBasePathMapping { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BasePath + The base path name that callers of the API must provide in the URL after the domain name. If you specify this property, it can't be an empty string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath PrimitiveType: String UpdateType: Immutable .PARAMETER DomainName + The DomainName of an AWS::ApiGateway::DomainName: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER RestApiId + The name of the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid PrimitiveType: String UpdateType: Mutable .PARAMETER Stage + The name of the API's stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 index 363b337f3..60db2a8ac 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayClientCertificate { <# .SYNOPSIS - Adds an AWS::ApiGateway::ClientCertificate resource to the template. + Adds an AWS::ApiGateway::ClientCertificate resource to the template. The AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint. .DESCRIPTION - Adds an AWS::ApiGateway::ClientCertificate resource to the template. + Adds an AWS::ApiGateway::ClientCertificate resource to the template. The AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html @@ -13,11 +13,15 @@ function New-VSApiGatewayClientCertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the client certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + + clientcertificate:generate: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/clientcertificate-generate/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 index e7a574f28..f8ca684b1 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayDeployment { <# .SYNOPSIS - Adds an AWS::ApiGateway::Deployment resource to the template. + Adds an AWS::ApiGateway::Deployment resource to the template. The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment. .DESCRIPTION - Adds an AWS::ApiGateway::Deployment resource to the template. + Adds an AWS::ApiGateway::Deployment resource to the template. The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html @@ -13,26 +13,36 @@ function New-VSApiGatewayDeployment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeploymentCanarySettings + Specifies settings for the canary deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings Type: DeploymentCanarySettings UpdateType: Immutable .PARAMETER Description + A description of the purpose of the API Gateway deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description PrimitiveType: String UpdateType: Mutable .PARAMETER RestApiId + The ID of the RestApi resource to deploy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid PrimitiveType: String UpdateType: Immutable .PARAMETER StageDescription + Configures the stage that API Gateway creates with this deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription Type: StageDescription UpdateType: Mutable .PARAMETER StageName + A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 index 7608160a8..390cdb93b 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayDocumentationPart { <# .SYNOPSIS - Adds an AWS::ApiGateway::DocumentationPart resource to the template. + Adds an AWS::ApiGateway::DocumentationPart resource to the template. The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGateway::DocumentationPart resource to the template. + Adds an AWS::ApiGateway::DocumentationPart resource to the template. The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html @@ -13,16 +13,22 @@ function New-VSApiGatewayDocumentationPart { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Location + The location of the API entity that the documentation applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location Type: Location UpdateType: Immutable .PARAMETER Properties + The documentation content map of the targeted API entity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties PrimitiveType: String UpdateType: Mutable .PARAMETER RestApiId + The identifier of the targeted API entity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 index 29645e4f7..674222f0c 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayDocumentationVersion { <# .SYNOPSIS - Adds an AWS::ApiGateway::DocumentationVersion resource to the template. + Adds an AWS::ApiGateway::DocumentationVersion resource to the template. The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGateway::DocumentationVersion resource to the template. + Adds an AWS::ApiGateway::DocumentationVersion resource to the template. The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html @@ -13,16 +13,22 @@ function New-VSApiGatewayDocumentationVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the API documentation snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description PrimitiveType: String UpdateType: Mutable .PARAMETER DocumentationVersion + The version identifier of the API documentation snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion PrimitiveType: String UpdateType: Immutable .PARAMETER RestApiId + The identifier of the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 index 1c55e3105..7d3662b51 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 @@ -1,10 +1,12 @@ function New-VSApiGatewayDomainName { <# .SYNOPSIS - Adds an AWS::ApiGateway::DomainName resource to the template. + Adds an AWS::ApiGateway::DomainName resource to the template. The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway. .DESCRIPTION - Adds an AWS::ApiGateway::DomainName resource to the template. + Adds an AWS::ApiGateway::DomainName resource to the template. The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway. + +You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html @@ -13,31 +15,43 @@ function New-VSApiGatewayDomainName { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CertificateArn + The reference to an AWS-managed certificate for use by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-prerequisites in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn PrimitiveType: String UpdateType: Mutable .PARAMETER DomainName + The custom domain name for your API. Uppercase letters are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER EndpointConfiguration + A list of the endpoint types of the domain name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration Type: EndpointConfiguration UpdateType: Mutable .PARAMETER RegionalCertificateArn + The reference to an AWS-managed certificate for use by the regional endpoint for the domain name. AWS Certificate Manager is the only supported source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityPolicy + + domainname:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/domainname-create/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + + domainname:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/domainname-create/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 index 4d360e349..73bfe5fd1 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayGatewayResponse { <# .SYNOPSIS - Adds an AWS::ApiGateway::GatewayResponse resource to the template. + Adds an AWS::ApiGateway::GatewayResponse resource to the template. The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGateway::GatewayResponse resource to the template. + Adds an AWS::ApiGateway::GatewayResponse resource to the template. The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html @@ -13,6 +13,8 @@ function New-VSApiGatewayGatewayResponse { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResponseParameters + The response parameters paths, query strings, and headers for the response. Duplicates not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters DuplicatesAllowed: False PrimitiveItemType: String @@ -20,6 +22,8 @@ function New-VSApiGatewayGatewayResponse { UpdateType: Mutable .PARAMETER ResponseTemplates + The response templates for the response. Duplicates not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates DuplicatesAllowed: False PrimitiveItemType: String @@ -27,16 +31,22 @@ function New-VSApiGatewayGatewayResponse { UpdateType: Mutable .PARAMETER ResponseType + The response type. For valid values, see GatewayResponse: https://docs.aws.amazon.com/apigateway/api-reference/resource/gateway-response/ in the *API Gateway API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype PrimitiveType: String UpdateType: Immutable .PARAMETER RestApiId + The identifier of the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid PrimitiveType: String UpdateType: Immutable .PARAMETER StatusCode + The HTTP status code for the response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 index ebb929691..8f294ee58 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayMethod { <# .SYNOPSIS - Adds an AWS::ApiGateway::Method resource to the template. + Adds an AWS::ApiGateway::Method resource to the template. The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests. .DESCRIPTION - Adds an AWS::ApiGateway::Method resource to the template. + Adds an AWS::ApiGateway::Method resource to the template. The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html @@ -13,11 +13,15 @@ function New-VSApiGatewayMethod { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApiKeyRequired + Indicates whether the method requires clients to submit a valid API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AuthorizationScopes + A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes match a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes DuplicatesAllowed: False PrimitiveItemType: String @@ -25,26 +29,37 @@ function New-VSApiGatewayMethod { UpdateType: Mutable .PARAMETER AuthorizationType + The method's authorization type. For valid values, see Method: https://docs.aws.amazon.com/apigateway/api-reference/resource/method/ in the *API Gateway API Reference*. +If you specify the AuthorizerId property, specify CUSTOM for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerId + The identifier of the authorizer: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html to use on this method. If you specify this property, specify CUSTOM for the AuthorizationType property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid PrimitiveType: String UpdateType: Mutable .PARAMETER HttpMethod + The HTTP method that clients use to call this method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod PrimitiveType: String UpdateType: Mutable .PARAMETER Integration + The backend system that the method calls when it receives a request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration Type: Integration UpdateType: Mutable .PARAMETER MethodResponses + The responses that can be sent to the client who calls the method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses DuplicatesAllowed: False ItemType: MethodResponse @@ -52,11 +67,15 @@ function New-VSApiGatewayMethod { UpdateType: Mutable .PARAMETER OperationName + A friendly operation name for the method. For example, you can assign the OperationName of ListPets for the GET /pets method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname PrimitiveType: String UpdateType: Mutable .PARAMETER RequestModels + The resources that are used for the response's content type. Specify response models as key-value pairs string-to-string mapping, with a content type as the key and a Model resource name as the value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels DuplicatesAllowed: False PrimitiveItemType: String @@ -64,6 +83,8 @@ function New-VSApiGatewayMethod { UpdateType: Mutable .PARAMETER RequestParameters + The request parameters that API Gateway accepts. Specify request parameters as key-value pairs string-to-Boolean mapping, with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request.location.name, where the location is query string, path, or header, and *name* is a valid, unique parameter name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters DuplicatesAllowed: False PrimitiveItemType: Boolean @@ -71,16 +92,22 @@ function New-VSApiGatewayMethod { UpdateType: Mutable .PARAMETER RequestValidatorId + The ID of the associated request validator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceId + The ID of an API Gateway resource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html. For root resource methods, specify the RestApi root resource ID, such as { "Fn::GetAtt": "MyRestApi", "RootResourceId"] }. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid PrimitiveType: String UpdateType: Mutable .PARAMETER RestApiId + The ID of the RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html resource in which API Gateway creates the method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 index 34d54e306..6801cb27a 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayModel { <# .SYNOPSIS - Adds an AWS::ApiGateway::Model resource to the template. + Adds an AWS::ApiGateway::Model resource to the template. The AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method. .DESCRIPTION - Adds an AWS::ApiGateway::Model resource to the template. + Adds an AWS::ApiGateway::Model resource to the template. The AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html @@ -13,26 +13,37 @@ function New-VSApiGatewayModel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ContentType + The content type for the model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A description that identifies this model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description PrimitiveType: String UpdateType: Mutable .PARAMETER Name + A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name PrimitiveType: String UpdateType: Immutable .PARAMETER RestApiId + The ID of a REST API with which to associate this model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid PrimitiveType: String UpdateType: Immutable .PARAMETER Schema + The schema to use to transform data to one or more output formats. Specify null {} if you don't want to specify a schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 index 26db4cf1d..4ec8e1333 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayRequestValidator { <# .SYNOPSIS - Adds an AWS::ApiGateway::RequestValidator resource to the template. + Adds an AWS::ApiGateway::RequestValidator resource to the template. The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see Enable Basic Request Validation for an API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGateway::RequestValidator resource to the template. + Adds an AWS::ApiGateway::RequestValidator resource to the template. The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see Enable Basic Request Validation for an API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html @@ -13,21 +13,29 @@ function New-VSApiGatewayRequestValidator { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name of this request validator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name PrimitiveType: String UpdateType: Immutable .PARAMETER RestApiId + The identifier of the targeted API entity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid PrimitiveType: String UpdateType: Immutable .PARAMETER ValidateRequestBody + Indicates whether to validate the request body according to the configured schema for the targeted API and method. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ValidateRequestParameters + Indicates whether to validate request parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 index 66625dfff..78354b8bc 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayResource { <# .SYNOPSIS - Adds an AWS::ApiGateway::Resource resource to the template. + Adds an AWS::ApiGateway::Resource resource to the template. The AWS::ApiGateway::Resource resource creates a resource in an API. .DESCRIPTION - Adds an AWS::ApiGateway::Resource resource to the template. + Adds an AWS::ApiGateway::Resource resource to the template. The AWS::ApiGateway::Resource resource creates a resource in an API. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html @@ -13,16 +13,22 @@ function New-VSApiGatewayResource { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ParentId + If you want to create a child resource, the ID of the parent resource. For resources without a parent, specify the RestApi root resource ID, such as { "Fn::GetAtt": "MyRestApi", "RootResourceId"] }. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid PrimitiveType: String UpdateType: Immutable .PARAMETER PathPart + A path name for the resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart PrimitiveType: String UpdateType: Immutable .PARAMETER RestApiId + The ID of the RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html resource in which you want to create this resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 index c10ff3bb2..56b793646 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 @@ -1,10 +1,14 @@ function New-VSApiGatewayRestApi { <# .SYNOPSIS - Adds an AWS::ApiGateway::RestApi resource to the template. + Adds an AWS::ApiGateway::RestApi resource to the template. The AWS::ApiGateway::RestApi resource creates a REST API. For more information, see restapi:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/restapi-create/ in the *Amazon API Gateway REST API Reference*. .DESCRIPTION - Adds an AWS::ApiGateway::RestApi resource to the template. + Adds an AWS::ApiGateway::RestApi resource to the template. The AWS::ApiGateway::RestApi resource creates a REST API. For more information, see restapi:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/restapi-create/ in the *Amazon API Gateway REST API Reference*. + +**Note** + +On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative: https://www.openapis.org/, becoming the foundation of the OpenAPI Specification. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html @@ -13,11 +17,17 @@ function New-VSApiGatewayRestApi { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApiKeySourceType + The source of the API key for metering requests according to a usage plan. Valid values are: ++ HEADER to read the API key from the X-API-Key header of a request. ++ AUTHORIZER to read the API key from the UsageIdentifierKey from a Lambda authorizer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER BinaryMediaTypes + The list of binary media types that are supported by the RestApi resource, such as image/png or application/octet-stream. By default, RestApi supports only UTF-8-encoded text payloads. For more information, see Enable Support for Binary Payloads in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html in the *API Gateway Developer Guide*. Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes DuplicatesAllowed: False PrimitiveItemType: String @@ -25,46 +35,64 @@ function New-VSApiGatewayRestApi { UpdateType: Mutable .PARAMETER Body + An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body PrimitiveType: Json UpdateType: Mutable .PARAMETER BodyS3Location + The Amazon Simple Storage Service Amazon S3 location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location Type: S3Location UpdateType: Mutable .PARAMETER CloneFrom + The ID of the RestApi resource that you want to clone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the RestApi resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description PrimitiveType: String UpdateType: Mutable .PARAMETER EndpointConfiguration + A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration Type: EndpointConfiguration UpdateType: Mutable .PARAMETER FailOnWarnings + Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MinimumCompressionSize + A nullable integer that is used to enable compression with non-negative between 0 and 10485760 10M bytes, inclusive or disable compression with a null value on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + A name for the RestApi resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + Custom header parameters for the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters DuplicatesAllowed: False PrimitiveItemType: String @@ -72,11 +100,15 @@ function New-VSApiGatewayRestApi { UpdateType: Mutable .PARAMETER Policy + A policy document that contains the permissions for the RestApi resource, in JSON format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + + restapi:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/restapi-create/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 index a224e283a..015efa623 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayStage { <# .SYNOPSIS - Adds an AWS::ApiGateway::Stage resource to the template. + Adds an AWS::ApiGateway::Stage resource to the template. The AWS::ApiGateway::Stage resource creates a stage for a deployment. .DESCRIPTION - Adds an AWS::ApiGateway::Stage resource to the template. + Adds an AWS::ApiGateway::Stage resource to the template. The AWS::ApiGateway::Stage resource creates a stage for a deployment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html @@ -13,46 +13,64 @@ function New-VSApiGatewayStage { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccessLogSetting + Specifies settings for logging access in this stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting Type: AccessLogSetting UpdateType: Mutable .PARAMETER CacheClusterEnabled + Indicates whether cache clustering is enabled for the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheClusterSize + The stage's cache cluster size. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize PrimitiveType: String UpdateType: Mutable .PARAMETER CanarySetting + Specifies settings for the canary deployment in this stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting Type: CanarySetting UpdateType: Mutable .PARAMETER ClientCertificateId + The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid PrimitiveType: String UpdateType: Mutable .PARAMETER DeploymentId + The ID of the deployment that the stage is associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description PrimitiveType: String UpdateType: Mutable .PARAMETER DocumentationVersion + The version ID of the API documentation snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion PrimitiveType: String UpdateType: Mutable .PARAMETER MethodSettings + Settings for all methods in the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings DuplicatesAllowed: False ItemType: MethodSetting @@ -60,16 +78,22 @@ function New-VSApiGatewayStage { UpdateType: Mutable .PARAMETER RestApiId + The ID of the RestApi resource that you're deploying with this stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid PrimitiveType: String UpdateType: Immutable .PARAMETER StageName + The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier URI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + An array of arbitrary tags key-value pairs to associate with the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags DuplicatesAllowed: True ItemType: Tag @@ -77,11 +101,16 @@ function New-VSApiGatewayStage { UpdateType: Mutable .PARAMETER TracingEnabled + Specifies whether active X-Ray tracing is enabled for this stage. +For more information, see Trace API Gateway API Execution with AWS X-Ray: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html in the *API Gateway Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Variables + A map string-to-string map that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: A-Za-z0-9-._~:/?#&=,]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 index 7c2e6cca3..14e55f875 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayUsagePlan { <# .SYNOPSIS - Adds an AWS::ApiGateway::UsagePlan resource to the template. + Adds an AWS::ApiGateway::UsagePlan resource to the template. The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan enforces throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGateway::UsagePlan resource to the template. + Adds an AWS::ApiGateway::UsagePlan resource to the template. The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan enforces throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html @@ -13,6 +13,8 @@ function New-VSApiGatewayUsagePlan { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApiStages + The API stages to associate with this usage plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages DuplicatesAllowed: False ItemType: ApiStage @@ -20,16 +22,22 @@ function New-VSApiGatewayUsagePlan { UpdateType: Mutable .PARAMETER Description + A description of the usage plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description PrimitiveType: String UpdateType: Mutable .PARAMETER Quota + Configures the number of requests that users can make within a given interval. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota Type: QuotaSettings UpdateType: Mutable .PARAMETER Tags + + usageplan:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/usageplan-create/ in the *Amazon API Gateway REST API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags DuplicatesAllowed: True ItemType: Tag @@ -37,11 +45,15 @@ function New-VSApiGatewayUsagePlan { UpdateType: Mutable .PARAMETER Throttle + Configures the overall request rate average requests per second and burst capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle Type: ThrottleSettings UpdateType: Mutable .PARAMETER UsagePlanName + A name for the usage plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 index eee82e126..6a2386468 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayUsagePlanKey { <# .SYNOPSIS - Adds an AWS::ApiGateway::UsagePlanKey resource to the template. + Adds an AWS::ApiGateway::UsagePlanKey resource to the template. The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to. .DESCRIPTION - Adds an AWS::ApiGateway::UsagePlanKey resource to the template. + Adds an AWS::ApiGateway::UsagePlanKey resource to the template. The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html @@ -13,16 +13,22 @@ function New-VSApiGatewayUsagePlanKey { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KeyId + The ID of the usage plan key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid PrimitiveType: String UpdateType: Immutable .PARAMETER KeyType + The type of usage plan key. Currently, the only valid key type is API_KEY. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype PrimitiveType: String UpdateType: Immutable .PARAMETER UsagePlanId + The value of the usage plan key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 index e6e088ff1..7ce1f4482 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Api { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Api resource to the template. + Adds an AWS::ApiGatewayV2::Api resource to the template. The AWS::ApiGatewayV2::Api resource creates an API. Currently only WebSocket APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Api resource to the template. + Adds an AWS::ApiGatewayV2::Api resource to the template. The AWS::ApiGatewayV2::Api resource creates an API. Currently only WebSocket APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html @@ -13,81 +13,113 @@ function New-VSApiGatewayV2Api { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RouteSelectionExpression + The route selection expression for the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER BodyS3Location + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Type: BodyS3Location Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location UpdateType: Mutable .PARAMETER Description + The description of the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description PrimitiveType: String UpdateType: Mutable .PARAMETER BasePath + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath PrimitiveType: String UpdateType: Mutable .PARAMETER FailOnWarnings + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DisableSchemaValidation + Avoid validating models when creating a deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The name of the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name PrimitiveType: String UpdateType: Mutable .PARAMETER Target + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target PrimitiveType: String UpdateType: Mutable .PARAMETER CredentialsArn + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn PrimitiveType: String UpdateType: Mutable .PARAMETER CorsConfiguration + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Type: Cors Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration UpdateType: Mutable .PARAMETER Version + A version identifier for the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version PrimitiveType: String UpdateType: Mutable .PARAMETER ProtocolType + The API protocol: Currently only WEBSOCKET is supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype PrimitiveType: String UpdateType: Immutable .PARAMETER RouteKey + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey PrimitiveType: String UpdateType: Mutable .PARAMETER Body + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER ApiKeySelectionExpression + An API key selection expression. See API Key Selection Expressions: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 index 3c9b9b307..e99269f3a 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2ApiMapping { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. + Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. For more information, see CreateApiMapping: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping in the *Amazon API Gateway V2 API Reference*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. + Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. For more information, see CreateApiMapping: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping in the *Amazon API Gateway V2 API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html @@ -13,21 +13,29 @@ function New-VSApiGatewayV2ApiMapping { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DomainName + The domain name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER Stage + The API stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage PrimitiveType: String UpdateType: Mutable .PARAMETER ApiMappingKey + The API mapping key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The identifier of the API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 index 6adec5687..e0d2a5ab4 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Authorizer { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Authorizer resource to the template. + Adds an AWS::ApiGatewayV2::Authorizer resource to the template. The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Authorizer resource to the template. + Adds an AWS::ApiGatewayV2::Authorizer resource to the template. The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html @@ -13,47 +13,66 @@ function New-VSApiGatewayV2Authorizer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER IdentityValidationExpression + The validation expression does not apply to the REQUEST authorizer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerUri + The authorizer's Uniform Resource Identifier URI. For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/FunctionARN]/invocations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerCredentialsArn + Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name ARN. To use resource-based permissions on the Lambda function, specify null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerType + The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype PrimitiveType: String UpdateType: Mutable .PARAMETER JwtConfiguration + + CreateAuthorizer: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers.html#CreateAuthorizer in the *Amazon API Gateway Version 2 API Reference* + Type: JWTConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration UpdateType: Mutable .PARAMETER AuthorizerResultTtlInSeconds + The time to live TTL, in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER IdentitySource + The identity source for which authorization is requested. +For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the authorizer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 index babc5089b..bbc251770 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Deployment { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Deployment resource to the template. + Adds an AWS::ApiGatewayV2::Deployment resource to the template. The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Deployment resource to the template. + Adds an AWS::ApiGatewayV2::Deployment resource to the template. The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html @@ -13,16 +13,22 @@ function New-VSApiGatewayV2Deployment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description for the deployment resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description PrimitiveType: String UpdateType: Mutable .PARAMETER StageName + The name of the Stage resource for the Deployment resource to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 index b7fc63e6a..c292e955d 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 @@ -1,10 +1,12 @@ function New-VSApiGatewayV2DomainName { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::DomainName resource to the template. + Adds an AWS::ApiGatewayV2::DomainName resource to the template. The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway. .DESCRIPTION - Adds an AWS::ApiGatewayV2::DomainName resource to the template. + Adds an AWS::ApiGatewayV2::DomainName resource to the template. The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway. + +You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html @@ -13,17 +15,23 @@ function New-VSApiGatewayV2DomainName { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DomainName + The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER DomainNameConfigurations + The domain name configurations. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations ItemType: DomainNameConfiguration UpdateType: Mutable .PARAMETER Tags + + CreateDomainName: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames.html#CreateDomainName in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 index f417f4ba2..872c72240 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Integration { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Integration resource to the template. + Adds an AWS::ApiGatewayV2::Integration resource to the template. The AWS::ApiGatewayV2::Integration resource creates an integration for an API. For more information, see Set up a WebSocket API Integration Request in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Integration resource to the template. + Adds an AWS::ApiGatewayV2::Integration resource to the template. The AWS::ApiGatewayV2::Integration resource creates an integration for an API. For more information, see Set up a WebSocket API Integration Request in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html @@ -13,71 +13,110 @@ function New-VSApiGatewayV2Integration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the integration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description PrimitiveType: String UpdateType: Mutable .PARAMETER TemplateSelectionExpression + The template selection expression for the integration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER ConnectionType + The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype PrimitiveType: String UpdateType: Mutable .PARAMETER IntegrationMethod + Specifies the integration's HTTP method type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER PassthroughBehavior + Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. +WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. +NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. +WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER RequestParameters + A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters PrimitiveType: Json UpdateType: Mutable .PARAMETER IntegrationUri + For a Lambda proxy integration, this is the URI of the Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri PrimitiveType: String UpdateType: Mutable .PARAMETER PayloadFormatVersion + + CreateIntegration: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations.html#CreateIntegration in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion PrimitiveType: String UpdateType: Mutable .PARAMETER CredentialsArn + Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name ARN. To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn PrimitiveType: String UpdateType: Mutable .PARAMETER RequestTemplates + Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template as a String is the value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates PrimitiveType: Json UpdateType: Mutable .PARAMETER TimeoutInMillis + Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis PrimitiveType: Integer UpdateType: Mutable .PARAMETER ContentHandlingStrategy + Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: +CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. +CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. +If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER IntegrationType + The integration type of an integration. One of the following: +AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. +AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. +HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration. +HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. +MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 index 830947efa..2f0c9cc32 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2IntegrationResponse { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. + Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an API. For more information, see Set up WebSocket API Integration Responses in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. + Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an API. For more information, see Set up WebSocket API Integration Responses in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html @@ -13,36 +13,53 @@ function New-VSApiGatewayV2IntegrationResponse { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResponseTemplates + The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates PrimitiveType: Json UpdateType: Mutable .PARAMETER TemplateSelectionExpression + The template selection expression for the integration response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER ResponseParameters + A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters PrimitiveType: Json UpdateType: Mutable .PARAMETER ContentHandlingStrategy + Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: +CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. +CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. +If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy PrimitiveType: String UpdateType: Mutable .PARAMETER IntegrationId + The integration ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid PrimitiveType: String UpdateType: Mutable .PARAMETER IntegrationResponseKey + The integration response key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 index c37ce01c5..f00430f35 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Model { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Model resource to the template. + Adds an AWS::ApiGatewayV2::Model resource to the template. The AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see Model Selection Expressions: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Model resource to the template. + Adds an AWS::ApiGatewayV2::Model resource to the template. The AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see Model Selection Expressions: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html @@ -13,26 +13,36 @@ function New-VSApiGatewayV2Model { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description PrimitiveType: String UpdateType: Mutable .PARAMETER ContentType + The content-type for the model, for example, "application/json". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype PrimitiveType: String UpdateType: Mutable .PARAMETER Schema + The schema for the model. For application/json models, this should be JSON schema draft 4 model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema PrimitiveType: Json UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 index 6b4a7abc0..20f383c12 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Route { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Route resource to the template. + Adds an AWS::ApiGatewayV2::Route resource to the template. The AWS::ApiGatewayV2::Route resource creates a route for a WebSocket API. For more information, see Set up Routes for a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Route resource to the template. + Adds an AWS::ApiGatewayV2::Route resource to the template. The AWS::ApiGatewayV2::Route resource creates a route for a WebSocket API. For more information, see Set up Routes for a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html @@ -13,62 +13,86 @@ function New-VSApiGatewayV2Route { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Target + The target for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target PrimitiveType: String UpdateType: Mutable .PARAMETER RouteResponseSelectionExpression + The route response selection expression for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerId + The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid PrimitiveType: String UpdateType: Mutable .PARAMETER RequestModels + The request models for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels PrimitiveType: Json UpdateType: Mutable .PARAMETER OperationName + The operation name for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizationScopes + The authorization scopes supported by this route. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes UpdateType: Mutable .PARAMETER ApiKeyRequired + Specifies whether an API key is required for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RouteKey + The route key for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizationType + The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype PrimitiveType: String UpdateType: Mutable .PARAMETER ModelSelectionExpression + The model selection expression for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER RequestParameters + The request parameters for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 index 00b32e273..21b6ab2be 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2RouteResponse { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::RouteResponse resource to the template. + Adds an AWS::ApiGatewayV2::RouteResponse resource to the template. The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see Set up Route Responses for a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::RouteResponse resource to the template. + Adds an AWS::ApiGatewayV2::RouteResponse resource to the template. The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see Set up Route Responses for a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html @@ -13,31 +13,43 @@ function New-VSApiGatewayV2RouteResponse { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RouteResponseKey + The route response key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey PrimitiveType: String UpdateType: Mutable .PARAMETER ResponseParameters + The route response parameters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters PrimitiveType: Json UpdateType: Mutable .PARAMETER RouteId + The route ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid PrimitiveType: String UpdateType: Immutable .PARAMETER ModelSelectionExpression + The model selection expression for the route response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER ResponseModels + The response models for the route response. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 index 4bf64d339..ef714a16a 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Stage { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Stage resource to the template. + Adds an AWS::ApiGatewayV2::Stage resource to the template. The AWS::ApiGatewayV2::Stage resource updates a stage for a WebSocket API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Stage resource to the template. + Adds an AWS::ApiGatewayV2::Stage resource to the template. The AWS::ApiGatewayV2::Stage resource updates a stage for a WebSocket API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html @@ -13,56 +13,78 @@ function New-VSApiGatewayV2Stage { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientCertificateId + The identifier of a client certificate for a Stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid PrimitiveType: String UpdateType: Mutable .PARAMETER DeploymentId + The deployment identifier for the API stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description for the API stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description PrimitiveType: String UpdateType: Mutable .PARAMETER AccessLogSettings + Settings for logging access in this stage. + Type: AccessLogSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings UpdateType: Mutable .PARAMETER AutoDeploy + + CreateStage: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages.html#CreateStage in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RouteSettings + Route settings for the stage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings PrimitiveType: Json UpdateType: Mutable .PARAMETER StageName + The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename PrimitiveType: String UpdateType: Immutable .PARAMETER StageVariables + A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match A-Za-z0-9-._~:/?#&=,]+. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables PrimitiveType: Json UpdateType: Mutable .PARAMETER ApiId + The API identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER DefaultRouteSettings + The default route settings for the stage. + Type: RouteSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings UpdateType: Mutable .PARAMETER Tags + + CreateStage: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages.html#CreateStage in the *Amazon API Gateway Version 2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 index ff86400d2..bb00ebaf2 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayVpcLink { <# .SYNOPSIS - Adds an AWS::ApiGateway::VpcLink resource to the template. + Adds an AWS::ApiGateway::VpcLink resource to the template. The AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC. For more information, see vpclink:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/vpclink-create/ in the Amazon API Gateway REST API Reference. .DESCRIPTION - Adds an AWS::ApiGateway::VpcLink resource to the template. + Adds an AWS::ApiGateway::VpcLink resource to the template. The AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC. For more information, see vpclink:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/vpclink-create/ in the Amazon API Gateway REST API Reference. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html @@ -13,17 +13,23 @@ function New-VSApiGatewayVpcLink { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the VPC link. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description PrimitiveType: String UpdateType: Mutable .PARAMETER TargetArns + The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns UpdateType: Immutable .PARAMETER Name + A name for the VPC link. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 index 332f70b99..e6aebcd15 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 @@ -1,10 +1,12 @@ function New-VSAppMeshMesh { <# .SYNOPSIS - Adds an AWS::AppMesh::Mesh resource to the template. + Adds an AWS::AppMesh::Mesh resource to the template. Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it. .DESCRIPTION - Adds an AWS::AppMesh::Mesh resource to the template. + Adds an AWS::AppMesh::Mesh resource to the template. Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it. + +After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html @@ -13,16 +15,22 @@ function New-VSAppMeshMesh { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MeshName + The name to use for the service mesh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-meshname PrimitiveType: String UpdateType: Immutable .PARAMETER Spec + The service mesh specification to apply. + Type: MeshSpec Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-spec UpdateType: Mutable .PARAMETER Tags + Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 index c04e3f1bb..1fc9ee1aa 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 @@ -1,10 +1,14 @@ function New-VSAppMeshRoute { <# .SYNOPSIS - Adds an AWS::AppMesh::Route resource to the template. + Adds an AWS::AppMesh::Route resource to the template. Creates a route that is associated with a virtual router. .DESCRIPTION - Adds an AWS::AppMesh::Route resource to the template. + Adds an AWS::AppMesh::Route resource to the template. Creates a route that is associated with a virtual router. + +You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics. + +If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html @@ -13,26 +17,36 @@ function New-VSAppMeshRoute { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MeshName + The name of the service mesh to create the route in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-meshname PrimitiveType: String UpdateType: Immutable .PARAMETER VirtualRouterName + The name of the virtual router in which to create the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-virtualroutername PrimitiveType: String UpdateType: Immutable .PARAMETER RouteName + The name to use for the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-routename PrimitiveType: String UpdateType: Immutable .PARAMETER Spec + The route specification to apply. + Type: RouteSpec Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-spec UpdateType: Mutable .PARAMETER Tags + Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 index 2e00f9ab7..c21c622ec 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 @@ -1,10 +1,20 @@ function New-VSAppMeshVirtualNode { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode resource to the template. + Adds an AWS::AppMesh::VirtualNode resource to the template. Creates a virtual node within a service mesh. .DESCRIPTION - Adds an AWS::AppMesh::VirtualNode resource to the template. + Adds an AWS::AppMesh::VirtualNode resource to the template. Creates a virtual node within a service mesh. + +A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery hostname for your task group. + +Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend. + +The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters. + +**Note** + +If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html @@ -13,21 +23,29 @@ function New-VSAppMeshVirtualNode { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MeshName + The name of the service mesh to create the virtual node in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-meshname PrimitiveType: String UpdateType: Immutable .PARAMETER Spec + The virtual node specification to apply. + Type: VirtualNodeSpec Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-spec UpdateType: Mutable .PARAMETER VirtualNodeName + The name to use for the virtual node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-virtualnodename PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 index 0b9cfbb02..d21f8572e 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 @@ -1,10 +1,14 @@ function New-VSAppMeshVirtualRouter { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualRouter resource to the template. + Adds an AWS::AppMesh::VirtualRouter resource to the template. Creates a virtual router within a service mesh. .DESCRIPTION - Adds an AWS::AppMesh::VirtualRouter resource to the template. + Adds an AWS::AppMesh::VirtualRouter resource to the template. Creates a virtual router within a service mesh. + +Any inbound traffic that your virtual router expects should be specified as a listener. + +Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html @@ -13,21 +17,29 @@ function New-VSAppMeshVirtualRouter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MeshName + The name of the service mesh to create the virtual router in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-meshname PrimitiveType: String UpdateType: Immutable .PARAMETER VirtualRouterName + The name to use for the virtual router. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-virtualroutername PrimitiveType: String UpdateType: Immutable .PARAMETER Spec + The virtual router specification to apply. + Type: VirtualRouterSpec Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-spec UpdateType: Mutable .PARAMETER Tags + Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 index c6a19ee61..cc40fa3ae 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 @@ -1,10 +1,12 @@ function New-VSAppMeshVirtualService { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService resource to the template. + Adds an AWS::AppMesh::VirtualService resource to the template. Creates a virtual service within a service mesh. .DESCRIPTION - Adds an AWS::AppMesh::VirtualService resource to the template. + Adds an AWS::AppMesh::VirtualService resource to the template. Creates a virtual service within a service mesh. + +A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html @@ -13,21 +15,29 @@ function New-VSAppMeshVirtualService { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MeshName + The name of the service mesh to create the virtual service in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-meshname PrimitiveType: String UpdateType: Immutable .PARAMETER VirtualServiceName + The name to use for the virtual service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-virtualservicename PrimitiveType: String UpdateType: Immutable .PARAMETER Spec + The virtual service specification to apply. + Type: VirtualServiceSpec Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-spec UpdateType: Mutable .PARAMETER Tags + Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 index a02292def..2d499a4c4 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 @@ -1,10 +1,10 @@ function New-VSAppStreamDirectoryConfig { <# .SYNOPSIS - Adds an AWS::AppStream::DirectoryConfig resource to the template. + Adds an AWS::AppStream::DirectoryConfig resource to the template. The AWS::AppStream::DirectoryConfig resource specifies the configuration information required to join Amazon AppStream 2.0 fleets and image builders to Microsoft Active Directory domains. .DESCRIPTION - Adds an AWS::AppStream::DirectoryConfig resource to the template. + Adds an AWS::AppStream::DirectoryConfig resource to the template. The AWS::AppStream::DirectoryConfig resource specifies the configuration information required to join Amazon AppStream 2.0 fleets and image builders to Microsoft Active Directory domains. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html @@ -13,17 +13,23 @@ function New-VSAppStreamDirectoryConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OrganizationalUnitDistinguishedNames + The distinguished names of the organizational units for computer accounts. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-organizationalunitdistinguishednames UpdateType: Mutable .PARAMETER ServiceAccountCredentials + The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentials as an input parameter with noEcho as shown in the Parameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html. For best practices information, see Do Not Embed Credentials in Your Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds. + Type: ServiceAccountCredentials Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-serviceaccountcredentials UpdateType: Mutable .PARAMETER DirectoryName + The fully qualified name of the directory for example, corp.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-directoryname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 index 5c98c33f7..8d302b648 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 @@ -1,10 +1,10 @@ function New-VSAppStreamFleet { <# .SYNOPSIS - Adds an AWS::AppStream::Fleet resource to the template. + Adds an AWS::AppStream::Fleet resource to the template. The AWS::AppStream::Fleet resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image. .DESCRIPTION - Adds an AWS::AppStream::Fleet resource to the template. + Adds an AWS::AppStream::Fleet resource to the template. The AWS::AppStream::Fleet resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html @@ -13,77 +13,135 @@ function New-VSAppStreamFleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description to display. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-description PrimitiveType: String UpdateType: Mutable .PARAMETER ComputeCapacity + The desired capacity for the fleet. + Type: ComputeCapacity Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-computecapacity UpdateType: Mutable .PARAMETER VpcConfig + The VPC configuration for the fleet. + Type: VpcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-vpcconfig UpdateType: Mutable .PARAMETER FleetType + The fleet type. +ALWAYS_ON +Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. +ON_DEMAND +Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-fleettype PrimitiveType: String UpdateType: Immutable .PARAMETER EnableDefaultInternetAccess + Enables or disables default internet access for the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-enabledefaultinternetaccess PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DomainJoinInfo + The name of the directory and organizational unit OU to use to join the fleet to a Microsoft Active Directory domain. + Type: DomainJoinInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-domainjoininfo UpdateType: Mutable .PARAMETER Name + A unique name for the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-name PrimitiveType: String UpdateType: Immutable .PARAMETER ImageName + The name of the image used to create the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-imagename PrimitiveType: String UpdateType: Mutable .PARAMETER MaxUserDurationInSeconds + The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. +Specify a value between 600 and 360000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxuserdurationinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER IdleDisconnectTimeoutInSeconds + The amount of time that users can be idle inactive before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. +To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. +If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes for example, 60, 120, and 180. If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-idledisconnecttimeoutinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER DisconnectTimeoutInSeconds + The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. +Specify a value between 60 and 360000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-disconnecttimeoutinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER DisplayName + The fleet name to display. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-displayname PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type to use when launching fleet instances. The following instance types are available: ++ stream.standard.medium ++ stream.standard.large ++ stream.compute.large ++ stream.compute.xlarge ++ stream.compute.2xlarge ++ stream.compute.4xlarge ++ stream.compute.8xlarge ++ stream.memory.large ++ stream.memory.xlarge ++ stream.memory.2xlarge ++ stream.memory.4xlarge ++ stream.memory.8xlarge ++ stream.graphics-design.large ++ stream.graphics-design.xlarge ++ stream.graphics-design.2xlarge ++ stream.graphics-design.4xlarge ++ stream.graphics-desktop.2xlarge ++ stream.graphics-pro.4xlarge ++ stream.graphics-pro.8xlarge ++ stream.graphics-pro.16xlarge + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs. For more information, see Using Cost Allocation Tags: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html in the *AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-tags ItemType: Tag UpdateType: Mutable .PARAMETER ImageArn + The ARN of the public, private, or shared image to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-imagearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 index 09cd41c14..26c21268a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 @@ -1,10 +1,12 @@ function New-VSAppStreamImageBuilder { <# .SYNOPSIS - Adds an AWS::AppStream::ImageBuilder resource to the template. + Adds an AWS::AppStream::ImageBuilder resource to the template. The AWS::AppStream::ImageBuilder resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image. .DESCRIPTION - Adds an AWS::AppStream::ImageBuilder resource to the template. + Adds an AWS::AppStream::ImageBuilder resource to the template. The AWS::AppStream::ImageBuilder resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image. + +The initial state of the image builder is PENDING. When it is ready, the state is RUNNING. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html @@ -13,62 +15,86 @@ function New-VSAppStreamImageBuilder { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ImageName + The name of the image used to create the image builder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagename PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description to display. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-description PrimitiveType: String UpdateType: Mutable .PARAMETER VpcConfig + The VPC configuration for the image builder. You can specify only one subnet. + Type: VpcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-vpcconfig UpdateType: Mutable .PARAMETER EnableDefaultInternetAccess + Enables or disables default internet access for the image builder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-enabledefaultinternetaccess PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DisplayName + The image builder name to display. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-displayname PrimitiveType: String UpdateType: Mutable .PARAMETER DomainJoinInfo + The name of the directory and organizational unit OU to use to join the image builder to a Microsoft Active Directory domain. + Type: DomainJoinInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-domainjoininfo UpdateType: Mutable .PARAMETER AppstreamAgentVersion + The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify LATEST]. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-appstreamagentversion PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type to use when launching the image builder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs. For more information, see Using Cost Allocation Tags: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html in the *AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + A unique name for the image builder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-name PrimitiveType: String UpdateType: Mutable .PARAMETER ImageArn + The ARN of the public, private, or shared image to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagearn PrimitiveType: String UpdateType: Mutable .PARAMETER AccessEndpoints + + CreateImageBuilder: https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateImageBuilder.html in the *Amazon AppStream 2.0 API Reference* + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-accessendpoints ItemType: AccessEndpoint diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 index 40c8b3e5f..0b21ad779 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 @@ -1,10 +1,10 @@ function New-VSAppStreamStack { <# .SYNOPSIS - Adds an AWS::AppStream::Stack resource to the template. + Adds an AWS::AppStream::Stack resource to the template. The AWS::AppStream::Stack resource creates a stack to start streaming applications to Amazon AppStream 2.0 users. A stack consists of an associated fleet, user access policies, and storage configurations. .DESCRIPTION - Adds an AWS::AppStream::Stack resource to the template. + Adds an AWS::AppStream::Stack resource to the template. The AWS::AppStream::Stack resource creates a stack to start streaming applications to Amazon AppStream 2.0 users. A stack consists of an associated fleet, user access policies, and storage configurations. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html @@ -13,71 +13,98 @@ function New-VSAppStreamStack { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description to display. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-description PrimitiveType: String UpdateType: Mutable .PARAMETER StorageConnectors + The storage connectors to enable. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-storageconnectors ItemType: StorageConnector UpdateType: Mutable .PARAMETER DeleteStorageConnectors + *This parameter has been deprecated. * +Deletes the storage connectors currently enabled for the stack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-deletestorageconnectors PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EmbedHostDomains + + CreateStack: https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateStack.html in the *Amazon AppStream 2.0 API Reference* + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-embedhostdomains UpdateType: Mutable .PARAMETER UserSettings + The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-usersettings ItemType: UserSetting UpdateType: Mutable .PARAMETER AttributesToDelete + The stack attributes to delete. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-attributestodelete UpdateType: Mutable .PARAMETER RedirectURL + The URL that users are redirected to after their streaming session ends. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-redirecturl PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the stack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-name PrimitiveType: String UpdateType: Immutable .PARAMETER FeedbackURL + The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-feedbackurl PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationSettings + The persistent application settings for users of the stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session. + Type: ApplicationSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-applicationsettings UpdateType: Mutable .PARAMETER DisplayName + The stack name to display. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-displayname PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs. For more information, see Using Cost Allocation Tags: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html in the *AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-tags ItemType: Tag UpdateType: Mutable .PARAMETER AccessEndpoints + + CreateStack: https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateStack.html in the *Amazon AppStream 2.0 API Reference* + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-accessendpoints ItemType: AccessEndpoint diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 index 4a77f8c8e..d6fd9f9d5 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSAppStreamStackFleetAssociation { <# .SYNOPSIS - Adds an AWS::AppStream::StackFleetAssociation resource to the template. + Adds an AWS::AppStream::StackFleetAssociation resource to the template. The AWS::AppStream::StackFleetAssociation resource associates the specified fleet with the specified stack for Amazon AppStream 2.0. .DESCRIPTION - Adds an AWS::AppStream::StackFleetAssociation resource to the template. + Adds an AWS::AppStream::StackFleetAssociation resource to the template. The AWS::AppStream::StackFleetAssociation resource associates the specified fleet with the specified stack for Amazon AppStream 2.0. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackfleetassociation.html @@ -13,11 +13,17 @@ function New-VSAppStreamStackFleetAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FleetName + The name of the fleet. +To associate a fleet with a stack, you must specify a dependency on the fleet resource. For more information, see DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackfleetassociation.html#cfn-appstream-stackfleetassociation-fleetname PrimitiveType: String UpdateType: Mutable .PARAMETER StackName + The name of the stack. +To associate a fleet with a stack, you must specify a dependency on the stack resource. For more information, see DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackfleetassociation.html#cfn-appstream-stackfleetassociation-stackname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 index 5576b4c62..da770faa9 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSAppStreamStackUserAssociation { <# .SYNOPSIS - Adds an AWS::AppStream::StackUserAssociation resource to the template. + Adds an AWS::AppStream::StackUserAssociation resource to the template. The AWS::AppStream::StackUserAssociation resource associates the specified users with the specified stacks for Amazon AppStream 2.0. Users in an AppStream 2.0 user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain. .DESCRIPTION - Adds an AWS::AppStream::StackUserAssociation resource to the template. + Adds an AWS::AppStream::StackUserAssociation resource to the template. The AWS::AppStream::StackUserAssociation resource associates the specified users with the specified stacks for Amazon AppStream 2.0. Users in an AppStream 2.0 user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html @@ -13,21 +13,30 @@ function New-VSAppStreamStackUserAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SendEmailNotification + Specifies whether a welcome email is sent to a user after the user is created in the user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-sendemailnotification PrimitiveType: Boolean UpdateType: Immutable .PARAMETER UserName + The email address of the user who is associated with the stack. +Users' email addresses are case-sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-username PrimitiveType: String UpdateType: Immutable .PARAMETER StackName + The name of the stack that is associated with the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-stackname PrimitiveType: String UpdateType: Immutable .PARAMETER AuthenticationType + The authentication type for the user who is associated with the stack. You must specify USERPOOL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-authenticationtype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 index 80c23a896..da24f8088 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 @@ -1,10 +1,10 @@ function New-VSAppStreamUser { <# .SYNOPSIS - Adds an AWS::AppStream::User resource to the template. + Adds an AWS::AppStream::User resource to the template. The AWS::AppStream::User resource creates a new user in the AppStream 2.0 user pool. .DESCRIPTION - Adds an AWS::AppStream::User resource to the template. + Adds an AWS::AppStream::User resource to the template. The AWS::AppStream::User resource creates a new user in the AppStream 2.0 user pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html @@ -13,26 +13,38 @@ function New-VSAppStreamUser { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER UserName + The email address of the user. +Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-username PrimitiveType: String UpdateType: Immutable .PARAMETER FirstName + The first name, or given name, of the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-firstname PrimitiveType: String UpdateType: Immutable .PARAMETER MessageAction + The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. +The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-messageaction PrimitiveType: String UpdateType: Immutable .PARAMETER LastName + The last name, or surname, of the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-lastname PrimitiveType: String UpdateType: Immutable .PARAMETER AuthenticationType + The authentication type for the user. You must specify USERPOOL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-authenticationtype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 index 725742417..1fee6196a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncApiKey { <# .SYNOPSIS - Adds an AWS::AppSync::ApiKey resource to the template. + Adds an AWS::AppSync::ApiKey resource to the template. The AWS::AppSync::ApiKey resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key. .DESCRIPTION - Adds an AWS::AppSync::ApiKey resource to the template. + Adds an AWS::AppSync::ApiKey resource to the template. The AWS::AppSync::ApiKey resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html @@ -13,16 +13,22 @@ function New-VSAppSyncApiKey { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Unique description of your API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description PrimitiveType: String UpdateType: Mutable .PARAMETER Expires + Expiration time of the API key in seconds using Unix Epoch time, with a minimum of 1 day and a maximum of 365 days. The default value is 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires PrimitiveType: Double UpdateType: Mutable .PARAMETER ApiId + Unique AWS AppSync GraphQL API ID for this API key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 index 9d398030c..c2d0f16a9 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncDataSource { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource resource to the template. + Adds an AWS::AppSync::DataSource resource to the template. The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB, AWS Lambda, and Amazon Elasticsearch Service. Resolvers use these data sources to fetch data when clients make GraphQL calls. .DESCRIPTION - Adds an AWS::AppSync::DataSource resource to the template. + Adds an AWS::AppSync::DataSource resource to the template. The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB, AWS Lambda, and Amazon Elasticsearch Service. Resolvers use these data sources to fetch data when clients make GraphQL calls. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html @@ -13,51 +13,78 @@ function New-VSAppSyncDataSource { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of the data source. ++ **AMAZON_DYNAMODB**: The data source is an Amazon DynamoDB table. ++ **AMAZON_ELASTICSEARCH**: The data source is an Amazon Elasticsearch Service domain. ++ **AWS_LAMBDA**: The data source is an AWS Lambda function. ++ **NONE**: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. ++ **HTTP**: The data source is an HTTP endpoint. ++ **RELATIONAL_DATABASE**: The data source is a relational database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description of the data source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceRoleArn + The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source. +Required if Type is specified as AWS_LAMBDA, AMAZON_DYNAMODB, or AMAZON_ELASTICSEARCH. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn PrimitiveType: String UpdateType: Mutable .PARAMETER HttpConfig + Endpoints for an HTTP data source. + Type: HttpConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-httpconfig UpdateType: Mutable .PARAMETER RelationalDatabaseConfig + Relational Database configuration of the relational database data source. + Type: RelationalDatabaseConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-relationaldatabaseconfig UpdateType: Mutable .PARAMETER LambdaConfig + A valid ARN of a Lambda function in your account. + Type: LambdaConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-lambdaconfig UpdateType: Mutable .PARAMETER ApiId + Unique AWS AppSync GraphQL API identifier where this data source will be created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + Friendly name for you to identify your AppSync data source after creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name PrimitiveType: String UpdateType: Immutable .PARAMETER DynamoDBConfig + AwsRegion and TableName for an Amazon DynamoDB table in your account. + Type: DynamoDBConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-dynamodbconfig UpdateType: Mutable .PARAMETER ElasticsearchConfig + AwsRegion and Endpoints for an Amazon Elasticsearch Service domain in your account. + Type: ElasticsearchConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-elasticsearchconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 index 0c43c838a..3482bc6df 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncFunctionConfiguration { <# .SYNOPSIS - Adds an AWS::AppSync::FunctionConfiguration resource to the template. + Adds an AWS::AppSync::FunctionConfiguration resource to the template. The AWS::AppSync::FunctionConfiguration resource defines the functions in GraphQL APIs to perform certain operations. You can use pipeline resolvers to attach functions. For more information, see Pipeline Resolvers: https://docs.aws.amazon.com/appsync/latest/devguide/pipeline-resolvers.html in the *AWS AppSync Developer Guide*. .DESCRIPTION - Adds an AWS::AppSync::FunctionConfiguration resource to the template. + Adds an AWS::AppSync::FunctionConfiguration resource to the template. The AWS::AppSync::FunctionConfiguration resource defines the functions in GraphQL APIs to perform certain operations. You can use pipeline resolvers to attach functions. For more information, see Pipeline Resolvers: https://docs.aws.amazon.com/appsync/latest/devguide/pipeline-resolvers.html in the *AWS AppSync Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html @@ -13,46 +13,64 @@ function New-VSAppSyncFunctionConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResponseMappingTemplateS3Location + The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplates3location PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The Function description. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-description PrimitiveType: String UpdateType: Mutable .PARAMETER DataSourceName + The name of data source this function will attach. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-datasourcename PrimitiveType: String UpdateType: Mutable .PARAMETER RequestMappingTemplate + The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ResponseMappingTemplate + The Function response mapping template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplate PrimitiveType: String UpdateType: Mutable .PARAMETER FunctionVersion + The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-functionversion PrimitiveType: String UpdateType: Mutable .PARAMETER RequestMappingTemplateS3Location + The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplates3location PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The AWS AppSync GraphQL API that you want to attach using this function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 index 2c485a174..70ca7228f 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncGraphQLApi { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLApi resource to the template. + Adds an AWS::AppSync::GraphQLApi resource to the template. The AWS::AppSync::GraphQLApi resource creates a new AppSync GraphQL API. This is the top-level construct for your application. For more information, see Quick Start: https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html in the *AWS AppSync Developer Guide*. .DESCRIPTION - Adds an AWS::AppSync::GraphQLApi resource to the template. + Adds an AWS::AppSync::GraphQLApi resource to the template. The AWS::AppSync::GraphQLApi resource creates a new AppSync GraphQL API. This is the top-level construct for your application. For more information, see Quick Start: https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html in the *AWS AppSync Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html @@ -13,41 +13,57 @@ function New-VSAppSyncGraphQLApi { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OpenIDConnectConfig + The OpenID Connect configuration. + Type: OpenIDConnectConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig UpdateType: Mutable .PARAMETER XrayEnabled + + CreateGraphqlApi: https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateGraphqlApi.html operation in the *AWS AppSync API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER UserPoolConfig + Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. + Type: UserPoolConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig UpdateType: Mutable .PARAMETER Tags + An arbitrary set of tags key-value pairs for this GraphQL API. + Type: Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-tags UpdateType: Mutable .PARAMETER Name + The API name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name PrimitiveType: String UpdateType: Mutable .PARAMETER AuthenticationType + Security configuration for your GraphQL API. For allowed values such as API_KEY, AWS_IAM, or AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, see Security: https://docs.aws.amazon.com/appsync/latest/devguide/security.html in the *AWS AppSync Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype PrimitiveType: String UpdateType: Mutable .PARAMETER LogConfig + The Amazon CloudWatch Logs configuration. + Type: LogConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig UpdateType: Mutable .PARAMETER AdditionalAuthenticationProviders + A list of additional authentication providers for the GraphqlApi API. + Type: AdditionalAuthenticationProviders Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-additionalauthenticationproviders UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 index a1926b58b..ef35c2c48 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncGraphQLSchema { <# .SYNOPSIS - Adds an AWS::AppSync::GraphQLSchema resource to the template. + Adds an AWS::AppSync::GraphQLSchema resource to the template. The AWS::AppSync::GraphQLSchema resource is used for your AWS AppSync GraphQL schema that controls the data model for your API. Schema files are text written in Schema Definition Language (SDL format. For more information about schema authoring, see Designing a GraphQL API: https://docs.aws.amazon.com/appsync/latest/devguide/designing-a-graphql-api.html in the *AWS AppSync Developer Guide*. .DESCRIPTION - Adds an AWS::AppSync::GraphQLSchema resource to the template. + Adds an AWS::AppSync::GraphQLSchema resource to the template. The AWS::AppSync::GraphQLSchema resource is used for your AWS AppSync GraphQL schema that controls the data model for your API. Schema files are text written in Schema Definition Language (SDL format. For more information about schema authoring, see Designing a GraphQL API: https://docs.aws.amazon.com/appsync/latest/devguide/designing-a-graphql-api.html in the *AWS AppSync Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html @@ -13,16 +13,23 @@ function New-VSAppSyncGraphQLSchema { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Definition + The text representation of a GraphQL schema in SDL format. +For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition PrimitiveType: String UpdateType: Mutable .PARAMETER DefinitionS3Location + The location of a GraphQL schema file in an Amazon S3 bucket. Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The AWS AppSync GraphQL API identifier to which you want to apply this schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-apiid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 index 9b4eac9fd..417e6600d 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncResolver { <# .SYNOPSIS - Adds an AWS::AppSync::Resolver resource to the template. + Adds an AWS::AppSync::Resolver resource to the template. The AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL format. For more information about resolvers, see Resolver Mapping Template Reference: https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html. .DESCRIPTION - Adds an AWS::AppSync::Resolver resource to the template. + Adds an AWS::AppSync::Resolver resource to the template. The AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL format. For more information about resolvers, see Resolver Mapping Template Reference: https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html @@ -13,61 +13,87 @@ function New-VSAppSyncResolver { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResponseMappingTemplateS3Location + The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplates3location PrimitiveType: String UpdateType: Mutable .PARAMETER TypeName + The GraphQL type that invokes this resolver. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-typename PrimitiveType: String UpdateType: Immutable .PARAMETER PipelineConfig + Functions linked with the pipeline resolver. + Type: PipelineConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-pipelineconfig UpdateType: Mutable .PARAMETER DataSourceName + The resolver data source name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-datasourcename PrimitiveType: String UpdateType: Mutable .PARAMETER RequestMappingTemplate + The request mapping template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ResponseMappingTemplate + The response mapping template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplate PrimitiveType: String UpdateType: Mutable .PARAMETER Kind + The resolver type. ++ **UNIT**: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. ++ **PIPELINE**: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-kind PrimitiveType: String UpdateType: Mutable .PARAMETER CachingConfig + + CreateResolver: https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateResolver.html operation in the *AWS AppSync API Reference*. + Type: CachingConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-cachingconfig UpdateType: Mutable .PARAMETER SyncConfig + + CreateResolver: https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateResolver.html operation in the *AWS AppSync API Reference*. + Type: SyncConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-syncconfig UpdateType: Mutable .PARAMETER RequestMappingTemplateS3Location + The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplates3location PrimitiveType: String UpdateType: Mutable .PARAMETER ApiId + The AWS AppSync GraphQL API to which you want to attach this resolver. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER FieldName + The GraphQL field on a type that invokes the resolver. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-fieldname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 index 073e5c3de..f9169efd3 100644 --- a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 @@ -1,10 +1,12 @@ function New-VSApplicationAutoScalingScalableTarget { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalableTarget resource to the template. + Adds an AWS::ApplicationAutoScaling::ScalableTarget resource to the template. The AWS::ApplicationAutoScaling::ScalableTarget resource specifies a resource that Application Auto Scaling can scale. .DESCRIPTION - Adds an AWS::ApplicationAutoScaling::ScalableTarget resource to the template. + Adds an AWS::ApplicationAutoScaling::ScalableTarget resource to the template. The AWS::ApplicationAutoScaling::ScalableTarget resource specifies a resource that Application Auto Scaling can scale. + +For more information, see RegisterScalableTarget: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html in the *Application Auto Scaling API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html @@ -13,31 +15,43 @@ function New-VSApplicationAutoScalingScalableTarget { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MaxCapacity + The maximum value to scale to in response to a scale-out event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-maxcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinCapacity + The minimum value to scale to in response to a scale-in event. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-mincapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER ResourceId + The resource identifier to associate with this scalable target. This string consists of the resource type and unique identifier. For valid values, see the ResourceId parameter for RegisterScalableTarget: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html in the *Application Auto Scaling API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-resourceid PrimitiveType: String UpdateType: Immutable .PARAMETER RoleARN + The Amazon Resource Name ARN of an AWS Identity and Access Management IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER ScalableDimension + The scalable dimension that is associated with the scalable target. Specify the service namespace, resource type, and scaling property, for example, ecs:service:DesiredCount for the desired task count of an Amazon ECS service. For valid values, see the ScalableDimension parameter for RegisterScalableTarget: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html in the *Application Auto Scaling API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scalabledimension PrimitiveType: String UpdateType: Immutable .PARAMETER ScheduledActions + The scheduled actions for the scalable target. Duplicates aren't allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scheduledactions DuplicatesAllowed: False ItemType: ScheduledAction @@ -45,11 +59,20 @@ function New-VSApplicationAutoScalingScalableTarget { UpdateType: Mutable .PARAMETER ServiceNamespace + The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For valid values, see the ServiceNamespace parameter for RegisterScalableTarget: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html in the *Application Auto Scaling API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-servicenamespace PrimitiveType: String UpdateType: Immutable .PARAMETER SuspendedState + An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false default resumes the specified scaling activities. +**Suspension Outcomes** ++ For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. ++ For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. ++ For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. +For more information, see Suspend and Resume Application Auto Scaling: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html in the *Application Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-suspendedstate Type: SuspendedState UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 index f7dc880be..67dff3002 100644 --- a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 @@ -1,10 +1,12 @@ function New-VSApplicationAutoScalingScalingPolicy { <# .SYNOPSIS - Adds an AWS::ApplicationAutoScaling::ScalingPolicy resource to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy resource to the template. The AWS::ApplicationAutoScaling::ScalingPolicy resource defines a scaling policy that Application Auto Scaling uses to adjust your application resources. .DESCRIPTION - Adds an AWS::ApplicationAutoScaling::ScalingPolicy resource to the template. + Adds an AWS::ApplicationAutoScaling::ScalingPolicy resource to the template. The AWS::ApplicationAutoScaling::ScalingPolicy resource defines a scaling policy that Application Auto Scaling uses to adjust your application resources. + +For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html in the *Application Auto Scaling API Reference*. For more information about scaling policies, see the Application Auto Scaling User Guide: https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html @@ -13,41 +15,62 @@ function New-VSApplicationAutoScalingScalingPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PolicyName + The name of the scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policyname PrimitiveType: String UpdateType: Immutable .PARAMETER PolicyType + The Application Auto Scaling policy type. Valid values are StepScaling and TargetTrackingScaling. +For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policytype PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceId + The unique resource identifier for the scalable target that this scaling policy applies to. For valid values, see the ResourceId parameter for PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html in the *Application Auto Scaling API Reference*. +You must specify either the ResourceId, ScalableDimension, and ServiceNamespace properties, or the ScalingTargetId property, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-resourceid PrimitiveType: String UpdateType: Immutable .PARAMETER ScalableDimension + The scalable dimension of the scalable target that this scaling policy applies to. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. For valid values, see the ScalableDimension parameter for PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html in the *Application Auto Scaling API Reference*. +You must specify either the ResourceId, ScalableDimension, and ServiceNamespace properties, or the ScalingTargetId property, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalabledimension PrimitiveType: String UpdateType: Immutable .PARAMETER ScalingTargetId + The AWS CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource. +You must specify either the ScalingTargetId property, or the ResourceId, ScalableDimension, and ServiceNamespace properties, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalingtargetid PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceNamespace + The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For valid values, see the ServiceNamespace parameter for PutScalingPolicy: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html in the *Application Auto Scaling API Reference*. +You must specify either the ResourceId, ScalableDimension, and ServiceNamespace properties, or the ScalingTargetId property, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-servicenamespace PrimitiveType: String UpdateType: Immutable .PARAMETER StepScalingPolicyConfiguration + A step scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration Type: StepScalingPolicyConfiguration UpdateType: Mutable .PARAMETER TargetTrackingScalingPolicyConfiguration + A target tracking scaling policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration Type: TargetTrackingScalingPolicyConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 b/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 index 1a57b6854..74c5efe85 100644 --- a/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 @@ -1,10 +1,10 @@ function New-VSAthenaNamedQuery { <# .SYNOPSIS - Adds an AWS::Athena::NamedQuery resource to the template. + Adds an AWS::Athena::NamedQuery resource to the template. The AWS::Athena::NamedQuery resource specifies an Amazon Athena query, where QueryString is the list of SQL query statements that comprise the query. For more information, see CreateNamedQuery: https://docs.aws.amazon.com/athena/latest/APIReference/API_CreateNamedQuery.html in the *Amazon Athena API Reference*. .DESCRIPTION - Adds an AWS::Athena::NamedQuery resource to the template. + Adds an AWS::Athena::NamedQuery resource to the template. The AWS::Athena::NamedQuery resource specifies an Amazon Athena query, where QueryString is the list of SQL query statements that comprise the query. For more information, see CreateNamedQuery: https://docs.aws.amazon.com/athena/latest/APIReference/API_CreateNamedQuery.html in the *Amazon Athena API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html @@ -13,21 +13,29 @@ function New-VSAthenaNamedQuery { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The query description. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-description PrimitiveType: String UpdateType: Immutable .PARAMETER QueryString + The SQL query statements that comprise the query. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-querystring PrimitiveType: String UpdateType: Immutable .PARAMETER Database + The database to which the query belongs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-database PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The query name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 index fe19d29c2..444ed78cc 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 @@ -1,10 +1,18 @@ function New-VSAutoScalingAutoScalingGroup { <# .SYNOPSIS - Adds an AWS::AutoScaling::AutoScalingGroup resource to the template. + Adds an AWS::AutoScaling::AutoScalingGroup resource to the template. Defines an Amazon EC2 Auto Scaling group with the specified name and attributes. .DESCRIPTION - Adds an AWS::AutoScaling::AutoScalingGroup resource to the template. + Adds an AWS::AutoScaling::AutoScalingGroup resource to the template. Defines an Amazon EC2 Auto Scaling group with the specified name and attributes. + +To configure Amazon EC2 instances launched as part of the group, you can specify a launch template or a launch configuration. We recommend that you use a launch template to make sure that you can use the latest features of Amazon EC2, such as T2 Unlimited instances. For more information, see Creating a Launch Template for an Auto Scaling Group: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html. + +**Important** + +You can add an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html to your Auto Scaling group to perform rolling updates (or replace the group when a change has been made to the group. You can find sample update policies for rolling updates in the Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#aws-properties-as-group--examples section. + +For more information, see CreateAutoScalingGroup: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html and UpdateAutoScalingGroup: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_UpdateAutoScalingGroup.html in the *Amazon EC2 Auto Scaling API Reference*. For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html @@ -13,11 +21,16 @@ function New-VSAutoScalingAutoScalingGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoScalingGroupName + The name of the Auto Scaling group. This name must be unique per Region per account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-autoscalinggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZones + A list of Availability Zones for the group. You must specify one of the following properties: VPCZoneIdentifier or AvailabilityZones. +If your account supports EC2-Classic and VPC, this property is required to create an Auto Scaling group that launches instances into EC2-Classic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-availabilityzones DuplicatesAllowed: True PrimitiveItemType: String @@ -25,41 +38,69 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER Cooldown + The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. +Used only when a scaling-specific cooldown is not specified and not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-cooldown PrimitiveType: String UpdateType: Mutable .PARAMETER DesiredCapacity + The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group. +CloudFormation marks the Auto Scaling group as successful by setting its status to CREATE_COMPLETE when the desired capacity is reached. However, if SpotPrice is set in the launch configuration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html, then desired capacity is not used as a criteria for success, because whether your request is fulfilled depends on Spot Instance capacity and your maximum price. If the current Spot price is less than your specified maximum price, Amazon EC2 Auto Scaling uses DesiredCapacity as the target capacity for the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckGracePeriod + The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. +For more information, see Health Checks for Auto Scaling Instances: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html in the *Amazon EC2 Auto Scaling User Guide*. +If you are adding an ELB health check, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-healthcheckgraceperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER HealthCheckType + The service to use for the health checks. The valid values are EC2 default and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. +For more information, see Health Checks for Auto Scaling Instances: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-healthchecktype PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceId + The ID of the instance used to create a launch configuration for the group. +When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the Auto Scaling group. The new launch configuration derives all its properties from the instance, with the exception of BlockDeviceMapping and AssociatePublicIpAddress. +For more information, see Create an Auto Scaling Group Using an EC2 Instance: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html in the *Amazon EC2 Auto Scaling User Guide*. +You must specify one of the following properties: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-instanceid PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchConfigurationName + The name of the LaunchConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html to use to launch instances. +You must specify one of the following properties: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy. +When you update LaunchConfigurationName, existing Amazon EC2 instances continue to run with the configuration that they were originally launched with. To update existing instances, specify an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html for the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-launchconfigurationname PrimitiveType: String UpdateType: Mutable .PARAMETER LaunchTemplate + The LaunchTemplate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html to use to launch instances. +You must specify one of the following properties: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy. +When you update LaunchTemplate, existing Amazon EC2 instances continue to run with the configuration that they were originally launched with. To update existing instances, specify an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html for the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-launchtemplate Type: LaunchTemplateSpecification UpdateType: Mutable .PARAMETER LifecycleHookSpecificationList + The lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecificationlist DuplicatesAllowed: True ItemType: LifecycleHookSpecification @@ -67,6 +108,9 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER LoadBalancerNames + A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead. +For more information, see Using a Load Balancer with an Auto Scaling Group: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-loadbalancernames DuplicatesAllowed: True PrimitiveItemType: String @@ -74,11 +118,15 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER MaxSize + The maximum number of Amazon EC2 instances in the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-maxsize PrimitiveType: String UpdateType: Mutable .PARAMETER MetricsCollection + Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-metricscollection DuplicatesAllowed: True ItemType: MetricsCollection @@ -86,16 +134,25 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER MinSize + The minimum number of Amazon EC2 instances in the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-minsize PrimitiveType: String UpdateType: Mutable .PARAMETER MixedInstancesPolicy + An embedded object that specifies a mixed instances policy. +The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the properties that specify the instance configuration information—the launch template and instance types. +For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html in the *Amazon EC2 Auto Scaling User Guide*. +You must specify one of the following properties: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-mixedinstancespolicy Type: MixedInstancesPolicy UpdateType: Mutable .PARAMETER NotificationConfigurations + Configures an Auto Scaling group to send notifications when specified events take place. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations DuplicatesAllowed: True ItemType: NotificationConfiguration @@ -103,16 +160,22 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER PlacementGroup + The name of an existing cluster placement group into which you want to launch your instances. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-placementgroup PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceLinkedRoleARN + The Amazon Resource Name ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-servicelinkedrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags for the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-tags DuplicatesAllowed: True ItemType: TagProperty @@ -120,6 +183,9 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER TargetGroupARNs + A list of Amazon Resource Names ARN of target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. +For more information, see Using a Load Balancer with an Auto Scaling Group: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-targetgrouparns DuplicatesAllowed: False PrimitiveItemType: String @@ -127,6 +193,9 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER TerminationPolicies + A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy. +For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-termpolicy DuplicatesAllowed: False PrimitiveItemType: String @@ -134,6 +203,11 @@ function New-VSAutoScalingAutoScalingGroup { UpdateType: Mutable .PARAMETER VPCZoneIdentifier + A list of subnet IDs for a virtual private cloud VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones. +If your account supports EC2-Classic and VPC, this property is required to create an Auto Scaling group that launches instances into a VPC. +If this resource has a public IP address and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html to declare a dependency on the VPC-gateway attachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html. +When you update VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can specify how AWS CloudFormation handles these updates by using an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-vpczoneidentifier DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 index 3e91b71c7..d380e6348 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 @@ -1,10 +1,18 @@ function New-VSAutoScalingLaunchConfiguration { <# .SYNOPSIS - Adds an AWS::AutoScaling::LaunchConfiguration resource to the template. + Adds an AWS::AutoScaling::LaunchConfiguration resource to the template. Specifies an Amazon EC2 Auto Scaling launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances. .DESCRIPTION - Adds an AWS::AutoScaling::LaunchConfiguration resource to the template. + Adds an AWS::AutoScaling::LaunchConfiguration resource to the template. Specifies an Amazon EC2 Auto Scaling launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances. + +**Important** + +When you update the launch configuration, AWS CloudFormation deletes that resource and creates a new launch configuration with the updated properties and a new name. This update action does not deploy any change across the running Amazon EC2 instances in the Auto Scaling group. In other words, after you associate a new launch configuration with an Auto Scaling group, all new instances will get the updated configuration, but existing instances continue to run with the configuration that they were originally launched with. This works the same way as any other Auto Scaling group that uses a launch configuration. + +If you want to update existing instances when you update the LaunchConfiguration resource, you must specify an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html for the Auto Scaling group. You can find sample update policies for rolling updates in the Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#aws-properties-as-group--examples section of the AWS::AutoScaling::AutoScalingGroup documentation. + +For more information, see CreateLaunchConfiguration: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateLaunchConfiguration.html in the *Amazon EC2 Auto Scaling API Reference* and Launch Configurations: https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html @@ -13,11 +21,17 @@ function New-VSAutoScalingLaunchConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssociatePublicIpAddress + For Auto Scaling groups that are running in a virtual private cloud VPC, specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html in the *Amazon EC2 Auto Scaling User Guide*. +If an instance receives a public IP address and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html to declare a dependency on the VPC-gateway attachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html. +If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cf-as-launchconfig-associatepubip PrimitiveType: Boolean UpdateType: Immutable .PARAMETER BlockDeviceMappings + Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-blockdevicemappings DuplicatesAllowed: False ItemType: BlockDeviceMapping @@ -25,11 +39,18 @@ function New-VSAutoScalingLaunchConfiguration { UpdateType: Immutable .PARAMETER ClassicLinkVPCId + The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. +For more information, see ClassicLink: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html in the *Amazon EC2 User Guide for Linux Instances* and Linking EC2-Classic Instances to a VPC: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink in the *Amazon EC2 Auto Scaling User Guide*. +This property can only be used if you are launching EC2-Classic instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-classiclinkvpcid PrimitiveType: String UpdateType: Immutable .PARAMETER ClassicLinkVPCSecurityGroups + The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property. +If you specify the ClassicLinkVPCId property, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-classiclinkvpcsecuritygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -37,61 +58,95 @@ function New-VSAutoScalingLaunchConfiguration { UpdateType: Immutable .PARAMETER EbsOptimized + Specifies whether the launch configuration is optimized for EBS I/O true or not false. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see EBS-Optimized Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html in the *Amazon EC2 User Guide for Linux Instances*. +The default value is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-ebsoptimized PrimitiveType: Boolean UpdateType: Immutable .PARAMETER IamInstanceProfile + Provides the name or the Amazon Resource Name ARN of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. +For more information, see IAM Role for Applications that Run on Amazon EC2 Instances: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-iaminstanceprofile PrimitiveType: String UpdateType: Immutable .PARAMETER ImageId + Provides the unique ID of the Amazon Machine Image AMI that was assigned during registration. For more information, see Finding an AMI: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-imageid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceId + The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this property if you want the launch configuration to use settings from an existing Amazon EC2 instance. +When you use an instance to create a launch configuration, all properties are derived from the instance with the exception of BlockDeviceMapping and AssociatePublicIpAddress. You can override any properties from the instance by specifying them in the launch configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-instanceid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceMonitoring + Controls whether instances in this group are launched with detailed true or basic false monitoring. The default value is true enabled. +When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-instancemonitoring PrimitiveType: Boolean UpdateType: Immutable .PARAMETER InstanceType + Specifies the instance type of the EC2 instance. For information about available instance types, see Available Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER KernelId + Provides the ID of the kernel associated with the EC2 AMI. +We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-kernelid PrimitiveType: String UpdateType: Immutable .PARAMETER KeyName + Provides the name of the EC2 key pair. +If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. For information on creating a key pair, see Amazon EC2 Key Pairs: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-keyname PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchConfigurationName + The name of the launch configuration. This name must be unique per Region per account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-autoscaling-launchconfig-launchconfigurationname PrimitiveType: String UpdateType: Immutable .PARAMETER PlacementTenancy + The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. You must set the value of this property to dedicated if want to launch dedicated instances in a shared tenancy VPC a VPC with the instance placement tenancy attribute set to default. +If you specify this property, you must specify at least one subnet in the VPCZoneIdentifier property of the AutoScalingGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html resource. +For more information, see Instance Placement Tenancy: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-placementtenancy PrimitiveType: String UpdateType: Immutable .PARAMETER RamDiskId + The ID of the RAM disk to select. +We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-ramdiskid PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroups + A list that contains the security groups to assign to the instances in the Auto Scaling group. The list can contain both the IDs of existing security groups and references to SecurityGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html resources created in the template. +For more information, see Security Groups for Your VPC: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html in the *Amazon Virtual Private Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-securitygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -99,11 +154,17 @@ function New-VSAutoScalingLaunchConfiguration { UpdateType: Immutable .PARAMETER SpotPrice + The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Launching Spot Instances in your Auto Scaling Group: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html in the *Amazon EC2 Auto Scaling User Guide*. +When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-spotprice PrimitiveType: String UpdateType: Immutable .PARAMETER UserData + The Base64-encoded user data to make available to the launched EC2 instances. +For more information, see Instance Metadata and User Data: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html in the *Amazon EC2 User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-userdata PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 index 0cc88b490..e0ab7f78f 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 @@ -1,10 +1,12 @@ function New-VSAutoScalingLifecycleHook { <# .SYNOPSIS - Adds an AWS::AutoScaling::LifecycleHook resource to the template. + Adds an AWS::AutoScaling::LifecycleHook resource to the template. Defines lifecycle hooks for an Amazon EC2 Auto Scaling group. Lifecycle hooks specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. When you use a lifecycle hook, the Auto Scaling group pauses the instance either after it is launched (before it is put into service or as it is terminated (before it is fully terminated. .DESCRIPTION - Adds an AWS::AutoScaling::LifecycleHook resource to the template. + Adds an AWS::AutoScaling::LifecycleHook resource to the template. Defines lifecycle hooks for an Amazon EC2 Auto Scaling group. Lifecycle hooks specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. When you use a lifecycle hook, the Auto Scaling group pauses the instance either after it is launched (before it is put into service or as it is terminated (before it is fully terminated. + +For more information, see PutLifecycleHook: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PutLifecycleHook.html in the *Amazon EC2 Auto Scaling API Reference* and Amazon EC2 Auto Scaling Lifecycle Hooks: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html @@ -13,41 +15,59 @@ function New-VSAutoScalingLifecycleHook { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoScalingGroupName + The name of the Auto Scaling group for the lifecycle hook. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-autoscalinggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DefaultResult + The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-defaultresult PrimitiveType: String UpdateType: Mutable .PARAMETER HeartbeatTimeout + The amount of time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-heartbeattimeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER LifecycleHookName + The name of the lifecycle hook. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecyclehookname PrimitiveType: String UpdateType: Immutable .PARAMETER LifecycleTransition + The instance state to which you want to attach the lifecycle hook. The valid values are: ++ autoscaling:EC2_INSTANCE_LAUNCHING ++ autoscaling:EC2_INSTANCE_TERMINATING + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-lifecycletransition PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationMetadata + Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-notificationmetadata PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationTargetARN + The Amazon Resource Name ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-notificationtargetarn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleARN + The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. For information about creating this role, see Preparing for Notifications: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html#preparing-for-notification in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 index c989b7593..9effec108 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 @@ -1,10 +1,22 @@ function New-VSAutoScalingPlansScalingPlan { <# .SYNOPSIS - Adds an AWS::AutoScalingPlans::ScalingPlan resource to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan resource to the template. The AWS::AutoScalingPlans::ScalingPlan resource defines a scaling plan that AWS Auto Scaling uses to scale the following application resources: .DESCRIPTION - Adds an AWS::AutoScalingPlans::ScalingPlan resource to the template. + Adds an AWS::AutoScalingPlans::ScalingPlan resource to the template. The AWS::AutoScalingPlans::ScalingPlan resource defines a scaling plan that AWS Auto Scaling uses to scale the following application resources: + ++ Amazon EC2 Auto Scaling groups + ++ Amazon EC2 Spot Fleet requests + ++ Amazon ECS services + ++ Amazon DynamoDB tables and global secondary indexes + ++ Amazon Aurora Replicas + +For more information, see the AWS Auto Scaling User Guide: https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html @@ -13,11 +25,15 @@ function New-VSAutoScalingPlansScalingPlan { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationSource + A CloudFormation stack or a set of tags. You can create one scaling plan per application source. + Type: ApplicationSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource UpdateType: Mutable .PARAMETER ScalingInstructions + The scaling instructions. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions ItemType: ScalingInstruction diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 index f53f33c6a..818bbc4f4 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 @@ -1,10 +1,16 @@ function New-VSAutoScalingScalingPolicy { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScalingPolicy resource to the template. + Adds an AWS::AutoScaling::ScalingPolicy resource to the template. Specifies a scaling policy for an Amazon EC2 Auto Scaling group. .DESCRIPTION - Adds an AWS::AutoScaling::ScalingPolicy resource to the template. + Adds an AWS::AutoScaling::ScalingPolicy resource to the template. Specifies a scaling policy for an Amazon EC2 Auto Scaling group. + +To update an existing scaling policy, use the existing policy name and set the property to change. If you leave a property unspecified when updating a scaling policy, the corresponding value remains unchanged. + +If you create either a step scaling policy or a simple scaling policy, you must also create a CloudWatch alarm that monitors a CloudWatch metric for your Auto Scaling group. Note that you can associate a CloudWatch alarm with only one scaling policy. + +For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html @@ -13,46 +19,72 @@ function New-VSAutoScalingScalingPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AdjustmentType + Specifies whether the ScalingAdjustment property is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. +Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-adjustmenttype PrimitiveType: String UpdateType: Mutable .PARAMETER AutoScalingGroupName + The name or Amazon Resource Name ARN of the Auto Scaling group that you want to attach the policy to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-autoscalinggroupname PrimitiveType: String UpdateType: Mutable .PARAMETER Cooldown + The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this property is not specified, the default cooldown period for the group applies. +Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html in the *Amazon EC2 Auto Scaling User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-cooldown PrimitiveType: String UpdateType: Mutable .PARAMETER EstimatedInstanceWarmup + The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group. +Valid only if the policy type is StepScaling or TargetTrackingScaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-estimatedinstancewarmup PrimitiveType: Integer UpdateType: Mutable .PARAMETER MetricAggregationType + The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. By default, AWS CloudFormation specifies Average. +Valid only if the policy type is StepScaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-metricaggregationtype PrimitiveType: String UpdateType: Mutable .PARAMETER MinAdjustmentMagnitude + The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. This property replaces the MinAdjustmentStep property. +For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. +Valid only if the policy type is StepScaling or SimpleScaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-minadjustmentmagnitude PrimitiveType: Integer UpdateType: Mutable .PARAMETER PolicyType + The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. By default, AWS CloudFormation specifies SimpleScaling. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-policytype PrimitiveType: String UpdateType: Mutable .PARAMETER ScalingAdjustment + The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType property either an absolute number or a percentage. A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value. +If you specify SimpleScaling for the policy type, you must specify this property. Not used with any other policy type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-scalingadjustment PrimitiveType: Integer UpdateType: Mutable .PARAMETER StepAdjustments + A set of adjustments that enable you to scale based on the size of the alarm breach. +If you specify StepScaling for the policy type, you must specify this property. Not used with any other policy type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-stepadjustments DuplicatesAllowed: False ItemType: StepAdjustment @@ -60,6 +92,9 @@ function New-VSAutoScalingScalingPolicy { UpdateType: Mutable .PARAMETER TargetTrackingConfiguration + Configures a target tracking scaling policy. +If you specify TargetTrackingScaling for the policy type, you must specify this property. Not used with any other policy type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration Type: TargetTrackingConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 index 00aa25b39..a88ba961f 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 @@ -1,10 +1,18 @@ function New-VSAutoScalingScheduledAction { <# .SYNOPSIS - Adds an AWS::AutoScaling::ScheduledAction resource to the template. + Adds an AWS::AutoScaling::ScheduledAction resource to the template. Specifies a scheduled scaling action for an Amazon EC2 Auto Scaling group, changing the number of servers available for your application in response to predictable load changes. .DESCRIPTION - Adds an AWS::AutoScaling::ScheduledAction resource to the template. + Adds an AWS::AutoScaling::ScheduledAction resource to the template. Specifies a scheduled scaling action for an Amazon EC2 Auto Scaling group, changing the number of servers available for your application in response to predictable load changes. + +**Important** + +When you update a stack with an Auto Scaling group and scheduled action, AWS CloudFormation always sets the min size, max size, and desired capacity properties of your group to the values that are defined in the AWS::AutoScaling::AutoScalingGroup section of your template. However, you might not want CloudFormation to do that when you have a scheduled action in effect. You can use an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html to prevent CloudFormation from changing the min size, max size, or desired capacity property values during a stack update unless you modified the individual values in your template. + +If you have rolling updates enabled, before you can update the Auto Scaling group, you must suspend scheduled actions by specifying an UpdatePolicy attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html for the Auto Scaling group. You can find sample update policies for rolling updates in the Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#aws-properties-as-group--examples section of the AWS::AutoScaling::AutoScalingGroup documentation. + +For more information, see Scheduled Scaling: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html and Suspending and Resuming Scaling Processes: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html in the *Amazon EC2 Auto Scaling User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html @@ -13,36 +21,54 @@ function New-VSAutoScalingScheduledAction { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoScalingGroupName + The name or Amazon Resource Name ARN of the Auto Scaling group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-asgname PrimitiveType: String UpdateType: Immutable .PARAMETER DesiredCapacity + The number of Amazon EC2 instances that should be running in the Auto Scaling group. +You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-desiredcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER EndTime + The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-endtime PrimitiveType: String UpdateType: Mutable .PARAMETER MaxSize + The maximum number of Amazon EC2 instances in the Auto Scaling group. +You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-maxsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinSize + The minimum number of Amazon EC2 instances in the Auto Scaling group. +You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-minsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER Recurrence + The recurring schedule for this action, in Unix cron syntax format. For more information about cron syntax, see Crontab: http://crontab.org/. +Specifying the StartTime and EndTime properties with Recurrence property forms the start and stop boundaries of the recurring action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-recurrence PrimitiveType: String UpdateType: Mutable .PARAMETER StartTime + The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-starttime PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 b/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 index 300594df8..cf8416482 100644 --- a/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 @@ -1,10 +1,10 @@ function New-VSBackupBackupPlan { <# .SYNOPSIS - Adds an AWS::Backup::BackupPlan resource to the template. + Adds an AWS::Backup::BackupPlan resource to the template. Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources. .DESCRIPTION - Adds an AWS::Backup::BackupPlan resource to the template. + Adds an AWS::Backup::BackupPlan resource to the template. Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html @@ -13,11 +13,15 @@ function New-VSBackupBackupPlan { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BackupPlan + Uniquely identifies the backup plan to be associated with the selection of resources. + Type: BackupPlanResourceType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#cfn-backup-backupplan-backupplan UpdateType: Mutable .PARAMETER BackupPlanTags + To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#cfn-backup-backupplan-backupplantags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 b/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 index b172d568c..7f1b9430c 100644 --- a/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 @@ -1,10 +1,10 @@ function New-VSBackupBackupSelection { <# .SYNOPSIS - Adds an AWS::Backup::BackupSelection resource to the template. + Adds an AWS::Backup::BackupSelection resource to the template. Specifies a set of resources to assign to a backup plan. .DESCRIPTION - Adds an AWS::Backup::BackupSelection resource to the template. + Adds an AWS::Backup::BackupSelection resource to the template. Specifies a set of resources to assign to a backup plan. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html @@ -13,11 +13,16 @@ function New-VSBackupBackupSelection { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BackupSelection + Specifies the body of a request to assign a set of resources to a backup plan. +It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources. + Type: BackupSelectionResourceType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#cfn-backup-backupselection-backupselection UpdateType: Immutable .PARAMETER BackupPlanId + Uniquely identifies a backup plan. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#cfn-backup-backupselection-backupplanid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 b/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 index 42a73b25d..217c1de34 100644 --- a/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 @@ -1,10 +1,14 @@ function New-VSBackupBackupVault { <# .SYNOPSIS - Adds an AWS::Backup::BackupVault resource to the template. + Adds an AWS::Backup::BackupVault resource to the template. Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. .DESCRIPTION - Adds an AWS::Backup::BackupVault resource to the template. + Adds an AWS::Backup::BackupVault resource to the template. Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. + +**Note** + +Sensitive data, such as passport numbers, should not be included the name of a backup vault. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html @@ -13,26 +17,36 @@ function New-VSBackupBackupVault { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BackupVaultTags + Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaulttags PrimitiveType: Json UpdateType: Mutable .PARAMETER BackupVaultName + The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultname PrimitiveType: String UpdateType: Immutable .PARAMETER EncryptionKeyArn + The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-encryptionkeyarn PrimitiveType: String UpdateType: Immutable .PARAMETER Notifications + The SNS event notifications for the specified backup vault. + Type: NotificationObjectType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-notifications UpdateType: Mutable .PARAMETER AccessPolicy + A resource-based policy that is used to manage access permissions on the target backup vault. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-accesspolicy PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 index 7aee64b18..e79b5effd 100644 --- a/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 @@ -1,10 +1,10 @@ function New-VSBatchComputeEnvironment { <# .SYNOPSIS - Adds an AWS::Batch::ComputeEnvironment resource to the template. + Adds an AWS::Batch::ComputeEnvironment resource to the template. The AWS::Batch::ComputeEnvironment resource defines your AWS Batch compute environment. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .DESCRIPTION - Adds an AWS::Batch::ComputeEnvironment resource to the template. + Adds an AWS::Batch::ComputeEnvironment resource to the template. The AWS::Batch::ComputeEnvironment resource defines your AWS Batch compute environment. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html @@ -13,26 +13,38 @@ function New-VSBatchComputeEnvironment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of the compute environment. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-type PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceRole + The full Amazon Resource Name ARN of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. +If your specified role has a path other than /, then you must either specify the full role ARN this is recommended or prefix the role name with the path. +Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole PrimitiveType: String UpdateType: Mutable .PARAMETER ComputeEnvironmentName + The name for your compute environment. Up to 128 letters uppercase and lowercase, numbers, hyphens, and underscores are allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeenvironmentname PrimitiveType: String UpdateType: Immutable .PARAMETER ComputeResources + The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. + Type: ComputeResources Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeresources UpdateType: Mutable .PARAMETER State + The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-state PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 index e57604703..128e7a21b 100644 --- a/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 @@ -1,10 +1,10 @@ function New-VSBatchJobDefinition { <# .SYNOPSIS - Adds an AWS::Batch::JobDefinition resource to the template. + Adds an AWS::Batch::JobDefinition resource to the template. The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition. For more information, see Job Definitions: https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html in the *AWS Batch User Guide*. .DESCRIPTION - Adds an AWS::Batch::JobDefinition resource to the template. + Adds an AWS::Batch::JobDefinition resource to the template. The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition. For more information, see Job Definitions: https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html @@ -13,36 +13,50 @@ function New-VSBatchJobDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of job definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER NodeProperties + An object with various properties specific to multi-node parallel jobs. + Type: NodeProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties UpdateType: Mutable .PARAMETER Timeout + The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. + Type: Timeout Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout UpdateType: Mutable .PARAMETER ContainerProperties + An object with various properties specific to container-based jobs. + Type: ContainerProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties UpdateType: Mutable .PARAMETER JobDefinitionName + The name of the job definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname PrimitiveType: String UpdateType: Immutable .PARAMETER RetryStrategy + The retry strategy to use for failed jobs that are submitted with this job definition. + Type: RetryStrategy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 b/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 index 06a0adaad..0bff5262b 100644 --- a/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 @@ -1,10 +1,10 @@ function New-VSBatchJobQueue { <# .SYNOPSIS - Adds an AWS::Batch::JobQueue resource to the template. + Adds an AWS::Batch::JobQueue resource to the template. The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition. For more information, see Job Queues: https://docs.aws.amazon.com/batch/latest/userguide/job_queues.html in the *AWS Batch User Guide*. .DESCRIPTION - Adds an AWS::Batch::JobQueue resource to the template. + Adds an AWS::Batch::JobQueue resource to the template. The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition. For more information, see Job Queues: https://docs.aws.amazon.com/batch/latest/userguide/job_queues.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html @@ -13,22 +13,30 @@ function New-VSBatchJobQueue { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ComputeEnvironmentOrder + The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder ItemType: ComputeEnvironmentOrder UpdateType: Mutable .PARAMETER Priority + The priority of the job queue. Job queues with a higher priority or a higher integer value for the priority parameter are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER State + The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state PrimitiveType: String UpdateType: Mutable .PARAMETER JobQueueName + The name of the job queue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 b/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 index a37da026a..9a12d2275 100644 --- a/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 @@ -1,10 +1,10 @@ function New-VSBudgetsBudget { <# .SYNOPSIS - Adds an AWS::Budgets::Budget resource to the template. + Adds an AWS::Budgets::Budget resource to the template. The AWS::Budgets::Budget resource creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html in the *AWS Billing and Cost Management User Guide*. .DESCRIPTION - Adds an AWS::Budgets::Budget resource to the template. + Adds an AWS::Budgets::Budget resource to the template. The AWS::Budgets::Budget resource creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html in the *AWS Billing and Cost Management User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html @@ -13,12 +13,16 @@ function New-VSBudgetsBudget { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER NotificationsWithSubscribers + A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-notificationswithsubscribers ItemType: NotificationWithSubscribers UpdateType: Immutable .PARAMETER Budget + The budget object that you want to create. + Type: BudgetData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-budget UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 index d6bdc9fb0..ecd7b2efb 100644 --- a/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 @@ -1,10 +1,14 @@ function New-VSCertificateManagerCertificate { <# .SYNOPSIS - Adds an AWS::CertificateManager::Certificate resource to the template. + Adds an AWS::CertificateManager::Certificate resource to the template. The AWS::CertificateManager::Certificate resource requests an AWS Certificate Manager (ACM certificate that you can use to enable secure connections. For example, you can deploy an ACM certificate to an Elastic Load Balancer to enable HTTPS support. For more information, see RequestCertificate: https://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html in the AWS Certificate Manager API Reference. .DESCRIPTION - Adds an AWS::CertificateManager::Certificate resource to the template. + Adds an AWS::CertificateManager::Certificate resource to the template. The AWS::CertificateManager::Certificate resource requests an AWS Certificate Manager (ACM certificate that you can use to enable secure connections. For example, you can deploy an ACM certificate to an Elastic Load Balancer to enable HTTPS support. For more information, see RequestCertificate: https://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html in the AWS Certificate Manager API Reference. + +**Important** + +When you use the AWS::CertificateManager::Certificate resource in an AWS CloudFormation stack, the stack will remain in the CREATE_IN_PROGRESS state. Further stack operations will be delayed until you validate the certificate request, either by acting upon the instructions in the validation email, or by adding a CNAME record to your DNS configuration. For more information, see Use Email to Validate Domain Ownership: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html and Use DNS to Validate Domain Ownership: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html @@ -13,11 +17,15 @@ function New-VSCertificateManagerCertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DomainName + The fully qualified domain name FQDN, such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk * to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER DomainValidationOptions + Domain information that domain name registrars use to verify your identity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions DuplicatesAllowed: False ItemType: DomainValidationOption @@ -25,6 +33,8 @@ function New-VSCertificateManagerCertificate { UpdateType: Immutable .PARAMETER SubjectAlternativeNames + Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames DuplicatesAllowed: False PrimitiveItemType: String @@ -32,6 +42,8 @@ function New-VSCertificateManagerCertificate { UpdateType: Immutable .PARAMETER Tags + Key-value pairs that can identity the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-tags DuplicatesAllowed: True ItemType: Tag @@ -39,6 +51,8 @@ function New-VSCertificateManagerCertificate { UpdateType: Mutable .PARAMETER ValidationMethod + The method you want to use to validate that you own or control the domain associated with a public certificate. You can validate with DNS: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html or validate with email: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html. We recommend that you use DNS validation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 b/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 index 5031b4056..1dfa2df2d 100644 --- a/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 @@ -1,10 +1,10 @@ function New-VSCloud9EnvironmentEC2 { <# .SYNOPSIS - Adds an AWS::Cloud9::EnvironmentEC2 resource to the template. + Adds an AWS::Cloud9::EnvironmentEC2 resource to the template. The AWS::Cloud9::EnvironmentEC2 resource creates an Amazon EC2 development environment in AWS Cloud9. For more information, see Creating an Environment: https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html in the *AWS Cloud9 User Guide*. .DESCRIPTION - Adds an AWS::Cloud9::EnvironmentEC2 resource to the template. + Adds an AWS::Cloud9::EnvironmentEC2 resource to the template. The AWS::Cloud9::EnvironmentEC2 resource creates an Amazon EC2 development environment in AWS Cloud9. For more information, see Creating an Environment: https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html in the *AWS Cloud9 User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html @@ -13,43 +13,59 @@ function New-VSCloud9EnvironmentEC2 { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Repositories + Any AWS CodeCommit source code repositories to be cloned into the development environment. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-repositories ItemType: Repository UpdateType: Immutable .PARAMETER OwnerArn + The Amazon Resource Name ARN of the environment owner. This ARN can be the ARN of any AWS Identity and Access Management IAM principal. If this value is not specified, the ARN defaults to this environment's creator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-ownerarn PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of the environment to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-description PrimitiveType: String UpdateType: Mutable .PARAMETER AutomaticStopTimeMinutes + The number of minutes until the running instance is shut down after the environment was last used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-automaticstoptimeminutes PrimitiveType: Integer UpdateType: Immutable .PARAMETER SubnetId + The ID of the subnet in Amazon Virtual Private Cloud Amazon VPC that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud Amazon EC2 instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceType + The type of instance to connect to the environment for example, t2.micro. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The name of the environment. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name of the environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 index 5ef690646..6f504fd8c 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 @@ -1,10 +1,16 @@ function New-VSCloudFormationCustomResource { <# .SYNOPSIS - Adds an AWS::CloudFormation::CustomResource resource to the template. + Adds an AWS::CloudFormation::CustomResource resource to the template. In a CloudFormation template, you use the AWS::CloudFormation::CustomResource or Custom::String resource type to specify custom resources. .DESCRIPTION - Adds an AWS::CloudFormation::CustomResource resource to the template. + Adds an AWS::CloudFormation::CustomResource resource to the template. In a CloudFormation template, you use the AWS::CloudFormation::CustomResource or Custom::String resource type to specify custom resources. + +Custom resources provide a way for you to write custom provisioning logic in CloudFormation template and have CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see Custom Resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html. + +**Note** + +If you use the VPC Endpoints: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html feature, custom resources in the VPC must have access to CloudFormation-specific Amazon Simple Storage Service (Amazon S3 buckets. Custom resources must send responses to a pre-signed Amazon S3 URL. If they can't send responses to Amazon S3, CloudFormation won't receive a response and the stack operation fails. For more information, see Setting Up VPC Endpoints for AWS CloudFormation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html @@ -13,6 +19,10 @@ function New-VSCloudFormationCustomResource { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ServiceToken + Only one property is defined by AWS for a custom resource: ServiceToken. All other properties are defined by the service provider. +The service token that was given to the template developer by the service provider to access the service, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same region in which you are creating the stack. +Updates are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 index 90730b917..f9a0fc511 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFormationMacro { <# .SYNOPSIS - Adds an AWS::CloudFormation::Macro resource to the template. + Adds an AWS::CloudFormation::Macro resource to the template. The AWS::CloudFormation::Macro resource is an CloudFormation resource type that creates an CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html. .DESCRIPTION - Adds an AWS::CloudFormation::Macro resource to the template. + Adds an AWS::CloudFormation::Macro resource to the template. The AWS::CloudFormation::Macro resource is an CloudFormation resource type that creates an CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html @@ -13,26 +13,36 @@ function New-VSCloudFormationMacro { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the macro. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description PrimitiveType: String UpdateType: Mutable .PARAMETER FunctionName + The Amazon Resource Name ARN of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname PrimitiveType: String UpdateType: Mutable .PARAMETER LogGroupName + The Amazon CloudWatch log group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname PrimitiveType: String UpdateType: Mutable .PARAMETER LogRoleARN + The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the macro. The name of the macro must be unique across all macros in the account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 index 1d59dd777..ce552362f 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 @@ -1,10 +1,22 @@ function New-VSCloudFormationStack { <# .SYNOPSIS - Adds an AWS::CloudFormation::Stack resource to the template. + Adds an AWS::CloudFormation::Stack resource to the template. The AWS::CloudFormation::Stack type nests a stack as a resource in a top-level template. .DESCRIPTION - Adds an AWS::CloudFormation::Stack resource to the template. + Adds an AWS::CloudFormation::Stack resource to the template. The AWS::CloudFormation::Stack type nests a stack as a resource in a top-level template. + +You can add output values from a nested stack within the containing template. You use the GetAtt: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs.NestedStackOutputName. + +**Important** + +We strongly recommend that updates to nested stacks are run from the parent stack. + +When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but does not update the resources of unmodified nested stacks. For more information, see CloudFormation Stacks Updates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html. + +**Note** + +You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation, see Controlling Access with AWS Identity and Access Management: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html @@ -13,6 +25,8 @@ function New-VSCloudFormationStack { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER NotificationARNs + The Simple Notification Service SNS topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface CLI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns DuplicatesAllowed: False PrimitiveItemType: String @@ -20,6 +34,11 @@ function New-VSCloudFormationStack { UpdateType: Mutable .PARAMETER Parameters + The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. +If you use the Ref function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type String. In other words, you cannot pass values that are of type CommaDelimitedList to nested stacks. +Conditional. Required if the nested stack requires input parameters. +Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters DuplicatesAllowed: False PrimitiveItemType: String @@ -27,6 +46,8 @@ function New-VSCloudFormationStack { UpdateType: Mutable .PARAMETER Tags + Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags DuplicatesAllowed: True ItemType: Tag @@ -34,11 +55,17 @@ function New-VSCloudFormationStack { UpdateType: Mutable .PARAMETER TemplateURL + Location of file containing the template body. The URL must point to a template max size: 460,800 bytes that is located in an Amazon S3 bucket. For more information, see Template Anatomy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html. +Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl PrimitiveType: String UpdateType: Mutable .PARAMETER TimeoutInMinutes + The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. The default is no timeout. When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. +Updates are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 index 559e59c9b..c08710e86 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 @@ -1,10 +1,24 @@ function New-VSCloudFormationWaitCondition { <# .SYNOPSIS - Adds an AWS::CloudFormation::WaitCondition resource to the template. + Adds an AWS::CloudFormation::WaitCondition resource to the template. **Important** .DESCRIPTION - Adds an AWS::CloudFormation::WaitCondition resource to the template. + Adds an AWS::CloudFormation::WaitCondition resource to the template. **Important** + +For Amazon EC2 and Auto Scaling resources, we recommend that you use a CreationPolicy attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully. + +You can use a wait condition for situations like the following: + ++ To coordinate stack resource creation with configuration actions that are external to the stack creation + ++ To track the status of a configuration process + +For these situations, we recommend that you associate a CreationPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html attribute with the wait condition so that you don't have to use a wait condition handle. For more information and an example, see Creating Wait Conditions in a Template: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html. If you use a CreationPolicy with a wait condition, do not specify any of the wait condition's properties. + +**Note** + +If you use the VPC Endpoints: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html feature, resources in the VPC that respond to wait conditions must have access to CloudFormation-specific Amazon Simple Storage Service (Amazon S3 buckets. Resources must send wait condition responses to a pre-signed Amazon S3 URL. If they can't send responses to Amazon S3, CloudFormation won't receive a response and the stack operation fails. For more information, see Setting Up VPC Endpoints for AWS CloudFormation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-vpce-bucketnames.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html @@ -13,16 +27,26 @@ function New-VSCloudFormationWaitCondition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Count + The number of success signals that CloudFormation must receive before it continues the stack creation process. When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition does not receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back. +Updates are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Handle + A reference to the wait condition handle used to signal this wait condition. Use the Ref intrinsic function to specify an AWS::CloudFormation::WaitConditionHandle: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html resource. +Anytime you add a WaitCondition resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Do not reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. +Updates are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle PrimitiveType: String UpdateType: Mutable .PARAMETER Timeout + The length of time in seconds to wait for the number of signals that the Count property specifies. Timeout is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours 43200 seconds. +Updates are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 index 750ebaa84..ca716b7a6 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 @@ -1,10 +1,24 @@ function New-VSCloudFormationWaitConditionHandle { <# .SYNOPSIS - Adds an AWS::CloudFormation::WaitConditionHandle resource to the template. + Adds an AWS::CloudFormation::WaitConditionHandle resource to the template. **Important** .DESCRIPTION - Adds an AWS::CloudFormation::WaitConditionHandle resource to the template. + Adds an AWS::CloudFormation::WaitConditionHandle resource to the template. **Important** + +For Amazon EC2 and Auto Scaling resources, we recommend that you use a CreationPolicy attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully. + +For more information, see Deploying Applications on Amazon EC2 with AWS CloudFormation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/deploying.applications.html. + +The AWS::CloudFormation::WaitConditionHandle type has no properties. When you reference the WaitConditionHandle resource by using the Ref function, AWS CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated AWS::CloudFormation::WaitCondition resource checks the URL for the required number of success signals or for a failure signal. + +**Important** + +Anytime you add a WaitCondition resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new WaitConditionHandle resource. Do not reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. + +**Note** + +Updates are not supported for this resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 index bb7f9c7cf..6a7520eb9 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFrontCloudFrontOriginAccessIdentity { <# .SYNOPSIS - Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. + Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. The request to create a new origin access identity. .DESCRIPTION - Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. + Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. The request to create a new origin access identity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html @@ -13,6 +13,8 @@ function New-VSCloudFrontCloudFrontOriginAccessIdentity { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CloudFrontOriginAccessIdentityConfig + The current configuration information for the identity. + Type: CloudFrontOriginAccessIdentityConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 index a12b7eddf..df289259a 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFrontDistribution { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution resource to the template. + Adds an AWS::CloudFront::Distribution resource to the template. The distribution's information. .DESCRIPTION - Adds an AWS::CloudFront::Distribution resource to the template. + Adds an AWS::CloudFront::Distribution resource to the template. The distribution's information. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html @@ -13,11 +13,15 @@ function New-VSCloudFrontDistribution { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DistributionConfig + The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource. + Type: DistributionConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-distributionconfig UpdateType: Mutable .PARAMETER Tags + A complex type that contains zero or more Tag elements. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 index e7437d400..5ba32f2c0 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFrontStreamingDistribution { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution resource to the template. + Adds an AWS::CloudFront::StreamingDistribution resource to the template. A streaming distribution. .DESCRIPTION - Adds an AWS::CloudFront::StreamingDistribution resource to the template. + Adds an AWS::CloudFront::StreamingDistribution resource to the template. A streaming distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html @@ -13,11 +13,15 @@ function New-VSCloudFrontStreamingDistribution { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER StreamingDistributionConfig + The current configuration information for the RTMP distribution. + Type: StreamingDistributionConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig UpdateType: Mutable .PARAMETER Tags + A complex type that contains zero or more Tag elements. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 b/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 index 3e18a102d..e5777639f 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 @@ -1,10 +1,10 @@ function New-VSCloudTrailTrail { <# .SYNOPSIS - Adds an AWS::CloudTrail::Trail resource to the template. + Adds an AWS::CloudTrail::Trail resource to the template. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. .DESCRIPTION - Adds an AWS::CloudTrail::Trail resource to the template. + Adds an AWS::CloudTrail::Trail resource to the template. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html @@ -13,21 +13,31 @@ function New-VSCloudTrailTrail { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CloudWatchLogsLogGroupArn + Specifies a log group name using an Amazon Resource Name ARN, a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsloggrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER CloudWatchLogsRoleArn + Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER EnableLogFileValidation + Specifies whether log file validation is enabled. The default is false. +When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-enablelogfilevalidation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EventSelectors + Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. +You can configure up to five event selectors for a trail. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-eventselectors DuplicatesAllowed: False ItemType: EventSelector @@ -35,41 +45,62 @@ function New-VSCloudTrailTrail { UpdateType: Mutable .PARAMETER IncludeGlobalServiceEvents + Specifies whether the trail is publishing events from global services such as IAM to the log files. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-includeglobalserviceevents PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IsLogging + Whether the CloudTrail is currently logging AWS API calls. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-islogging PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IsMultiRegionTrail + Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails replications of the trail will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-ismultiregiontrail PrimitiveType: Boolean UpdateType: Mutable .PARAMETER KMSKeyId + Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. +Examples: ++ alias/MyAliasName ++ arn:aws:kms:us-east-2:123456789012:alias/MyAliasName ++ arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 ++ 12345678-1234-1234-1234-123456789012 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-kmskeyid PrimitiveType: String UpdateType: Mutable .PARAMETER S3BucketName + Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-s3bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER S3KeyPrefix + Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html. The maximum length is 200 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-s3keyprefix PrimitiveType: String UpdateType: Mutable .PARAMETER SnsTopicName + Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-snstopicname PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An arbitrary set of tags key–value pairs for this trail. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-tags DuplicatesAllowed: True ItemType: Tag @@ -77,6 +108,15 @@ function New-VSCloudTrailTrail { UpdateType: Mutable .PARAMETER TrailName + Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements: ++ Contain only ASCII letters a-z, A-Z, numbers 0-9, periods ., underscores _, or dashes - ++ Start with a letter or number, and end with a letter or number ++ Be between 3 and 128 characters ++ Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. ++ Not be in IP address format for example, 192.168.5.4 +If Name is a trail ARN, it must be in the format: +arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-trailname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 index 466137d5e..ce144dfe2 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 @@ -1,10 +1,14 @@ function New-VSCloudWatchAlarm { <# .SYNOPSIS - Adds an AWS::CloudWatch::Alarm resource to the template. + Adds an AWS::CloudWatch::Alarm resource to the template. The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression. .DESCRIPTION - Adds an AWS::CloudWatch::Alarm resource to the template. + Adds an AWS::CloudWatch::Alarm resource to the template. The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression. + +When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. + +When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html @@ -13,11 +17,15 @@ function New-VSCloudWatchAlarm { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ActionsEnabled + Indicates whether actions should be executed during any changes to the alarm state. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AlarmActions + The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name ARN. For more information about creating alarms and the actions that you can specify, see PutMetricAlarm: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html in the *Amazon CloudWatch API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions DuplicatesAllowed: True PrimitiveItemType: String @@ -25,26 +33,38 @@ function New-VSCloudWatchAlarm { UpdateType: Mutable .PARAMETER AlarmDescription + The description of the alarm. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription PrimitiveType: String UpdateType: Mutable .PARAMETER AlarmName + The name of the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname PrimitiveType: String UpdateType: Immutable .PARAMETER ComparisonOperator + The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. +You can specify the following values: GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, or LessThanOrEqualToThreshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator PrimitiveType: String UpdateType: Mutable .PARAMETER DatapointsToAlarm + The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation in the *Amazon CloudWatch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm PrimitiveType: Integer UpdateType: Mutable .PARAMETER Dimensions + The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension DuplicatesAllowed: True ItemType: Dimension @@ -52,21 +72,30 @@ function New-VSCloudWatchAlarm { UpdateType: Mutable .PARAMETER EvaluateLowSampleCountPercentile + Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile PrimitiveType: String UpdateType: Mutable .PARAMETER EvaluationPeriods + The number of periods over which data is compared to the specified threshold. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods PrimitiveType: Integer UpdateType: Mutable .PARAMETER ExtendedStatistic + The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. +For an alarm based on a math expression, you can't specify ExtendedStatistic. Instead, you use Metrics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic PrimitiveType: String UpdateType: Mutable .PARAMETER InsufficientDataActions + The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions DuplicatesAllowed: True PrimitiveItemType: String @@ -74,11 +103,16 @@ function New-VSCloudWatchAlarm { UpdateType: Mutable .PARAMETER MetricName + The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname PrimitiveType: String UpdateType: Mutable .PARAMETER Metrics + An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. +If you specify the Metrics parameter, you cannot specify MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics DuplicatesAllowed: False ItemType: MetricDataQuery @@ -86,11 +120,15 @@ function New-VSCloudWatchAlarm { UpdateType: Mutable .PARAMETER Namespace + The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace PrimitiveType: String UpdateType: Mutable .PARAMETER OKActions + The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions DuplicatesAllowed: True PrimitiveItemType: String @@ -98,31 +136,45 @@ function New-VSCloudWatchAlarm { UpdateType: Mutable .PARAMETER Period + The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period PrimitiveType: Integer UpdateType: Mutable .PARAMETER Statistic + The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic. +For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic PrimitiveType: String UpdateType: Mutable .PARAMETER Threshold + The value to compare with the specified statistic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold PrimitiveType: Double UpdateType: Mutable .PARAMETER ThresholdMetricId + In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold PrimitiveType: String UpdateType: Mutable .PARAMETER TreatMissingData + Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. For more information, see Configuring How CloudWatch Alarms Treat Missing Data: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data in the *Amazon CloudWatch User Guide*. +If you omit this parameter, the default behavior of missing is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata PrimitiveType: String UpdateType: Mutable .PARAMETER Unit + The unit of the metric associated with the alarm. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 index 5958da889..fc3f55711 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 @@ -1,10 +1,10 @@ function New-VSCloudWatchAnomalyDetector { <# .SYNOPSIS - Adds an AWS::CloudWatch::AnomalyDetector resource to the template. + Adds an AWS::CloudWatch::AnomalyDetector resource to the template. The AWS::CloudWatch::AnomalyDetector type specifies an anomaly detection band for a certain metric and statistic. The band represents the expected "normal" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values, and for alarms. .DESCRIPTION - Adds an AWS::CloudWatch::AnomalyDetector resource to the template. + Adds an AWS::CloudWatch::AnomalyDetector resource to the template. The AWS::CloudWatch::AnomalyDetector type specifies an anomaly detection band for a certain metric and statistic. The band represents the expected "normal" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values, and for alarms. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html @@ -13,27 +13,37 @@ function New-VSCloudWatchAnomalyDetector { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MetricName + The name of the metric associated with the anomaly detection band. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname PrimitiveType: String UpdateType: Immutable .PARAMETER Stat + The statistic of the metric associated with the anomaly detection band. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat PrimitiveType: String UpdateType: Immutable .PARAMETER Configuration + Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric. + Type: Configuration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration UpdateType: Mutable .PARAMETER Dimensions + The dimensions of the metric associated with the anomaly detection band. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions ItemType: Dimension UpdateType: Immutable .PARAMETER Namespace + The namespace of the metric associated with the anomaly detection band. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 index 9f0e6ecab..d2011611a 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 @@ -1,10 +1,12 @@ function New-VSCloudWatchDashboard { <# .SYNOPSIS - Adds an AWS::CloudWatch::Dashboard resource to the template. + Adds an AWS::CloudWatch::Dashboard resource to the template. The AWS::CloudWatch::Dashboard resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view. .DESCRIPTION - Adds an AWS::CloudWatch::Dashboard resource to the template. + Adds an AWS::CloudWatch::Dashboard resource to the template. The AWS::CloudWatch::Dashboard resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view. + +There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html @@ -13,11 +15,16 @@ function New-VSCloudWatchDashboard { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DashboardName + The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname PrimitiveType: String UpdateType: Immutable .PARAMETER DashboardBody + The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required. +For more information about the syntax, see Dashboard Body Structure and Syntax: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 index 7068b1f12..7038febab 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 @@ -1,10 +1,10 @@ function New-VSCodeBuildProject { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project resource to the template. + Adds an AWS::CodeBuild::Project resource to the template. The AWS::CodeBuild::Project resource configures how AWS CodeBuild builds your source code. For example, it tells CodeBuild where to get the source code and which build environment to use. .DESCRIPTION - Adds an AWS::CodeBuild::Project resource to the template. + Adds an AWS::CodeBuild::Project resource to the template. The AWS::CodeBuild::Project resource configures how AWS CodeBuild builds your source code. For example, it tells CodeBuild where to get the source code and which build environment to use. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html @@ -13,100 +13,156 @@ function New-VSCodeBuildProject { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description that makes the build project easy to identify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-description PrimitiveType: String UpdateType: Mutable .PARAMETER VpcConfig + VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud: https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html in the *AWS CodeBuild User Guide*. + Type: VpcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-vpcconfig UpdateType: Mutable .PARAMETER SecondarySources + An array of ProjectSource objects. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysources ItemType: Source UpdateType: Mutable .PARAMETER EncryptionKey + The alias or Amazon Resource Name ARN of the AWS Key Management Service AWS KMS customer master key CMK that CodeBuild uses to encrypt the build output. If you don't specify a value, CodeBuild uses the AWS-managed CMK for Amazon Simple Storage Service Amazon S3. +You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. +You can specify either the Amazon Resource Name ARN of the CMK or, if available, the CMK's alias using the format alias/alias-name . + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-encryptionkey PrimitiveType: String UpdateType: Mutable .PARAMETER SourceVersion + A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: ++ For AWS CodeCommit: the commit ID to use. ++ For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID for example pr/25. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. ++ For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. ++ For Amazon Simple Storage Service Amazon S3: the version ID of the object that represents the build input ZIP file to use. +If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion at the project level. +For more information, see Source Version Sample with CodeBuild: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html in the *AWS CodeBuild User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion PrimitiveType: String UpdateType: Mutable .PARAMETER Triggers + For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository. + Type: ProjectTriggers Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-triggers UpdateType: Mutable .PARAMETER SecondaryArtifacts + A list of Artifacts objects. Each artifacts object specifies output settings that the project generates during a build. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondaryartifacts ItemType: Artifacts UpdateType: Mutable .PARAMETER Source + The source code settings for the project, such as the source code's repository type and location. + Type: Source Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-source UpdateType: Mutable .PARAMETER Name + The name of the build project. The name must be unique across all of the projects in your AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-name PrimitiveType: String UpdateType: Immutable .PARAMETER Artifacts + Artifacts is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies output settings for artifacts generated by an AWS CodeBuild build. + Type: Artifacts Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-artifacts UpdateType: Mutable .PARAMETER BadgeEnabled + Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. For more information, see Build Badges Sample: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-badges.html in the *AWS CodeBuild User Guide*. +Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify CODEPIPELINE for the Source property, do not specify the BadgeEnabled property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LogsConfig + Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both. + Type: LogsConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-logsconfig UpdateType: Mutable .PARAMETER ServiceRole + The ARN of the AWS Identity and Access Management IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-servicerole PrimitiveType: String UpdateType: Mutable .PARAMETER QueuedTimeoutInMinutes + The number of minutes a build is allowed to be queued before it times out. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-queuedtimeoutinminutes PrimitiveType: Integer UpdateType: Mutable + .PARAMETER FileSystemLocations + + CreateProject: https://docs.aws.amazon.com/codebuild/latest/APIReference/API_CreateProject.html in the *AWS CodeBuild API Reference* + + Type: List + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-filesystemlocations + ItemType: ProjectFileSystemLocation + UpdateType: Mutable + .PARAMETER Environment + The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. + Type: Environment Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment UpdateType: Mutable .PARAMETER SecondarySourceVersions + An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions at the project level. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysourceversions ItemType: ProjectSourceVersion UpdateType: Mutable .PARAMETER Tags + An arbitrary set of tags key-value pairs for the AWS CodeBuild project. +These tags are available for use by AWS services that support AWS CodeBuild build project tags. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-tags ItemType: Tag UpdateType: Mutable .PARAMETER TimeoutInMinutes + How long, in minutes, from 5 to 480 8 hours, for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-timeoutinminutes PrimitiveType: Integer UpdateType: Mutable .PARAMETER Cache + Settings that AWS CodeBuild uses to store and reuse build dependencies. + Type: ProjectCache Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-cache UpdateType: Mutable @@ -265,6 +321,17 @@ function New-VSCodeBuildProject { } })] $QueuedTimeoutInMinutes, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.CodeBuild.Project.ProjectFileSystemLocation" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $FileSystemLocations, [parameter(Mandatory = $true)] $Environment, [parameter(Mandatory = $false)] @@ -371,6 +438,12 @@ function New-VSCodeBuildProject { } $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name SecondaryArtifacts -Value @($SecondaryArtifacts) } + FileSystemLocations { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name FileSystemLocations -Value @($FileSystemLocations) + } SecondarySourceVersions { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 index 2d1f9dfa3..b965a533d 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 @@ -1,10 +1,14 @@ function New-VSCodeBuildSourceCredential { <# .SYNOPSIS - Adds an AWS::CodeBuild::SourceCredential resource to the template. + Adds an AWS::CodeBuild::SourceCredential resource to the template. Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials or the NoEcho parameter to mask your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. .DESCRIPTION - Adds an AWS::CodeBuild::SourceCredential resource to the template. + Adds an AWS::CodeBuild::SourceCredential resource to the template. Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials or the NoEcho parameter to mask your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. + +**Important** + +For security purposes, do not use plain text in your CloudFormation template to store your credentials. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html @@ -13,21 +17,29 @@ function New-VSCodeBuildSourceCredential { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ServerType + The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-servertype PrimitiveType: String UpdateType: Immutable .PARAMETER Username + The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-username PrimitiveType: String UpdateType: Mutable .PARAMETER Token + For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-token PrimitiveType: String UpdateType: Mutable .PARAMETER AuthType + The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-authtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 b/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 index db3e3a029..5cde70e25 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 @@ -1,10 +1,10 @@ function New-VSCodeCommitRepository { <# .SYNOPSIS - Adds an AWS::CodeCommit::Repository resource to the template. + Adds an AWS::CodeCommit::Repository resource to the template. Creates a new, empty repository. .DESCRIPTION - Adds an AWS::CodeCommit::Repository resource to the template. + Adds an AWS::CodeCommit::Repository resource to the template. Creates a new, empty repository. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html @@ -13,27 +13,39 @@ function New-VSCodeCommitRepository { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RepositoryName + The name of the new repository to be created. +The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html in the AWS CodeCommit User Guide. The suffix ".git" is prohibited. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositoryname PrimitiveType: String UpdateType: Mutable .PARAMETER Triggers + The JSON block of configuration information for each trigger. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-triggers ItemType: RepositoryTrigger UpdateType: Conditional .PARAMETER Code + Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. + Type: Code Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-code UpdateType: Mutable .PARAMETER RepositoryDescription + A comment or description about the new repository. +The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositorydescription PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + One or more tag key-value pairs to use when tagging this repository. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 index 4f2835af5..f911662d1 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 @@ -1,10 +1,10 @@ function New-VSCodeDeployApplication { <# .SYNOPSIS - Adds an AWS::CodeDeploy::Application resource to the template. + Adds an AWS::CodeDeploy::Application resource to the template. The AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application. In CodeDeploy, an application is a name that functions as a container to ensure that the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment. You can use the AWS::CodeDeploy::DeploymentGroup resource to associate the application with a CodeDeploy deployment group. For more information, see CodeDeploy Deployments: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-steps.html in the *AWS CodeDeploy User Guide*. .DESCRIPTION - Adds an AWS::CodeDeploy::Application resource to the template. + Adds an AWS::CodeDeploy::Application resource to the template. The AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application. In CodeDeploy, an application is a name that functions as a container to ensure that the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment. You can use the AWS::CodeDeploy::DeploymentGroup resource to associate the application with a CodeDeploy deployment group. For more information, see CodeDeploy Deployments: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-steps.html in the *AWS CodeDeploy User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html @@ -13,11 +13,16 @@ function New-VSCodeDeployApplication { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +Updates to ApplicationName are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER ComputePlatform + The compute platform that CodeDeploy deploys the application to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-computeplatform PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 index 431442b21..6e5abd3d2 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 @@ -1,10 +1,10 @@ function New-VSCodeDeployDeploymentConfig { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentConfig resource to the template. + Adds an AWS::CodeDeploy::DeploymentConfig resource to the template. The AWS::CodeDeploy::DeploymentConfig resource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies, through the use of a MinimumHealthyHosts value, the number or percentage of instances that must remain available at any time during a deployment. .DESCRIPTION - Adds an AWS::CodeDeploy::DeploymentConfig resource to the template. + Adds an AWS::CodeDeploy::DeploymentConfig resource to the template. The AWS::CodeDeploy::DeploymentConfig resource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies, through the use of a MinimumHealthyHosts value, the number or percentage of instances that must remain available at any time during a deployment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html @@ -13,11 +13,22 @@ function New-VSCodeDeployDeploymentConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeploymentConfigName + A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-deploymentconfigname PrimitiveType: String UpdateType: Immutable .PARAMETER MinimumHealthyHosts + The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value. +The type parameter takes either of the following values: ++ HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value. ++ FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances. +The value parameter takes an integer. +For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95. +For more information about instance health, see CodeDeploy Instance Health: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html in the AWS CodeDeploy User Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts Type: MinimumHealthyHosts UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 index 6c87aa1a1..614a60e1e 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 @@ -1,10 +1,10 @@ function New-VSCodeDeployDeploymentGroup { <# .SYNOPSIS - Adds an AWS::CodeDeploy::DeploymentGroup resource to the template. + Adds an AWS::CodeDeploy::DeploymentGroup resource to the template. The AWS::CodeDeploy::DeploymentGroup resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options. For more information, see CreateDeploymentGroup: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeploymentGroup.html in the *CodeDeploy API Reference*. .DESCRIPTION - Adds an AWS::CodeDeploy::DeploymentGroup resource to the template. + Adds an AWS::CodeDeploy::DeploymentGroup resource to the template. The AWS::CodeDeploy::DeploymentGroup resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options. For more information, see CreateDeploymentGroup: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeploymentGroup.html in the *CodeDeploy API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html @@ -13,21 +13,29 @@ function New-VSCodeDeployDeploymentGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AlarmConfiguration + Information about the Amazon CloudWatch alarms that are associated with the deployment group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-alarmconfiguration Type: AlarmConfiguration UpdateType: Mutable .PARAMETER ApplicationName + The name of an existing CodeDeploy application to associate this deployment group with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER AutoRollbackConfiguration + Information about the automatic rollback configuration that is associated with the deployment group. If you specify this property, don't specify the Deployment property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration Type: AutoRollbackConfiguration UpdateType: Mutable .PARAMETER AutoScalingGroups + A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created. Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autoscalinggroups DuplicatesAllowed: False PrimitiveItemType: String @@ -35,26 +43,40 @@ function New-VSCodeDeployDeploymentGroup { UpdateType: Mutable .PARAMETER Deployment + The application revision to deploy to this deployment group. If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deployment Type: Deployment UpdateType: Mutable .PARAMETER DeploymentConfigName + A deployment configuration name or a predefined configuration name. With predefined configurations, you can deploy application revisions to one instance at a time, half of the instances at a time, or all the instances at once. For more information and valid values, see Working with Deployment Configurations: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html in the *AWS CodeDeploy User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentconfigname PrimitiveType: String UpdateType: Mutable .PARAMETER DeploymentGroupName + A name for the deployment group. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DeploymentStyle + Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. +If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups, LoadBalancerInfo, or Deployment properties. +For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentstyle Type: DeploymentStyle UpdateType: Mutable .PARAMETER Ec2TagFilters + The EC2 tags that are already applied to EC2 instances that you want to include in the deployment group. CodeDeploy includes all EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed. +You can specify EC2TagFilters or Ec2TagSet, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagfilters DuplicatesAllowed: False ItemType: EC2TagFilter @@ -62,16 +84,23 @@ function New-VSCodeDeployDeploymentGroup { UpdateType: Mutable .PARAMETER Ec2TagSet + Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagset Type: EC2TagSet UpdateType: Mutable .PARAMETER LoadBalancerInfo + Information about the load balancer to use in a deployment. For more information, see Integrating CodeDeploy with Elastic Load Balancing : https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html in the *AWS CodeDeploy User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo Type: LoadBalancerInfo UpdateType: Mutable .PARAMETER OnPremisesInstanceTagFilters + The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy, see Working with On-Premises Instances for CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html in the *AWS CodeDeploy User Guide*. Duplicates are not allowed. +You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisesinstancetagfilters DuplicatesAllowed: False ItemType: TagFilter @@ -79,16 +108,24 @@ function New-VSCodeDeployDeploymentGroup { UpdateType: Mutable .PARAMETER OnPremisesTagSet + Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all the tag groups. +You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisestagset Type: OnPremisesTagSet UpdateType: Mutable .PARAMETER ServiceRoleArn + A service role Amazon Resource Name ARN that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy: https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html in the *AWS CodeDeploy User Guide*. +In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-servicerolearn PrimitiveType: String UpdateType: Mutable .PARAMETER TriggerConfigurations + Information about triggers associated with the deployment group. Duplicates are not allowed + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations DuplicatesAllowed: False ItemType: TriggerConfig diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 index 5c8c84575..6d752c3b4 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 @@ -1,10 +1,10 @@ function New-VSCodePipelineCustomActionType { <# .SYNOPSIS - Adds an AWS::CodePipeline::CustomActionType resource to the template. + Adds an AWS::CodePipeline::CustomActionType resource to the template. The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. For more information, see Create and Add a Custom Action in AWS CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html in the *AWS CodePipeline User Guide*. .DESCRIPTION - Adds an AWS::CodePipeline::CustomActionType resource to the template. + Adds an AWS::CodePipeline::CustomActionType resource to the template. The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. For more information, see Create and Add a Custom Action in AWS CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html in the *AWS CodePipeline User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html @@ -13,11 +13,17 @@ function New-VSCodePipelineCustomActionType { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Category + The category of the custom action, such as a build action or a test action. +Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category PrimitiveType: String UpdateType: Immutable .PARAMETER ConfigurationProperties + The configuration properties for the custom action. +You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties DuplicatesAllowed: False ItemType: ConfigurationProperties @@ -25,21 +31,29 @@ function New-VSCodePipelineCustomActionType { UpdateType: Immutable .PARAMETER InputArtifactDetails + The details of the input artifact for the action, such as its commit ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails Type: ArtifactDetails UpdateType: Immutable .PARAMETER OutputArtifactDetails + The details of the output artifact of the action, such as its commit ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails Type: ArtifactDetails UpdateType: Immutable .PARAMETER Provider + The provider of the service used in the custom action, such as AWS CodeDeploy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider PrimitiveType: String UpdateType: Immutable .PARAMETER Settings + URLs that provide users information about this custom action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings Type: Settings UpdateType: Immutable @@ -52,6 +66,8 @@ function New-VSCodePipelineCustomActionType { UpdateType: Mutable .PARAMETER Version + The version identifier of the custom action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 index 377fbd04c..50eded61f 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 @@ -1,10 +1,10 @@ function New-VSCodePipelinePipeline { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline resource to the template. + Adds an AWS::CodePipeline::Pipeline resource to the template. The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see What Is CodePipeline?: https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html in the *AWS CodePipeline User Guide*. .DESCRIPTION - Adds an AWS::CodePipeline::Pipeline resource to the template. + Adds an AWS::CodePipeline::Pipeline resource to the template. The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see What Is CodePipeline?: https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html in the *AWS CodePipeline User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html @@ -13,11 +13,16 @@ function New-VSCodePipelinePipeline { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ArtifactStore + The Amazon S3 bucket where artifacts are stored for the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore Type: ArtifactStore UpdateType: Mutable .PARAMETER ArtifactStores + A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. +If you create a cross-region action in your pipeline, you must use artifactStores. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores DuplicatesAllowed: False ItemType: ArtifactStoreMap @@ -25,6 +30,8 @@ function New-VSCodePipelinePipeline { UpdateType: Mutable .PARAMETER DisableInboundStageTransitions + Represents the input of a DisableStageTransition action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions DuplicatesAllowed: False ItemType: StageTransition @@ -32,21 +39,29 @@ function New-VSCodePipelinePipeline { UpdateType: Mutable .PARAMETER Name + The name of the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name PrimitiveType: String UpdateType: Immutable .PARAMETER RestartExecutionOnUpdate + Indicates whether to rerun the CodePipeline pipeline after you update it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Stages + Represents information about a stage and its definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages DuplicatesAllowed: False ItemType: StageDeclaration diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 index fdd181a83..b6c53204a 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 @@ -1,10 +1,10 @@ function New-VSCodePipelineWebhook { <# .SYNOPSIS - Adds an AWS::CodePipeline::Webhook resource to the template. + Adds an AWS::CodePipeline::Webhook resource to the template. The AWS::CodePipeline::Webhook resource creates and registers your webhook. After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see Configure Your GitHub Pipelines to Use Webhooks for Change Detection: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-webhooks-migration.html in the *AWS CodePipeline User Guide*. .DESCRIPTION - Adds an AWS::CodePipeline::Webhook resource to the template. + Adds an AWS::CodePipeline::Webhook resource to the template. The AWS::CodePipeline::Webhook resource creates and registers your webhook. After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see Configure Your GitHub Pipelines to Use Webhooks for Change Detection: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-webhooks-migration.html in the *AWS CodePipeline User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html @@ -13,42 +13,61 @@ function New-VSCodePipelineWebhook { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AuthenticationConfiguration + Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set. + Type: WebhookAuthConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration UpdateType: Mutable .PARAMETER Filters + A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters ItemType: WebhookFilterRule UpdateType: Mutable .PARAMETER Authentication + Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED. ++ For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks: https://developer.github.com/webhooks/securing/ on the GitHub Developer website. ++ IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration. ++ UNAUTHENTICATED will accept all webhook trigger requests regardless of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication PrimitiveType: String UpdateType: Mutable .PARAMETER TargetPipeline + The name of the pipeline you want to connect to the webhook. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline PrimitiveType: String UpdateType: Mutable .PARAMETER TargetAction + The name of the action in a pipeline you want to connect to the webhook. The action must be from the source first stage of the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the webhook. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name PrimitiveType: String UpdateType: Immutable .PARAMETER TargetPipelineVersion + The version number of the pipeline to be connected to the trigger request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion PrimitiveType: Integer UpdateType: Mutable .PARAMETER RegisterWithThirdParty + Configures a connection between the webhook that was created and the external tool with events to be detected. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 b/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 index ecc08bdc7..0bee02c5c 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 @@ -1,10 +1,10 @@ function New-VSCodeStarGitHubRepository { <# .SYNOPSIS - Adds an AWS::CodeStar::GitHubRepository resource to the template. + Adds an AWS::CodeStar::GitHubRepository resource to the template. The AWS::CodeStar::GitHubRepository resource creates a GitHub repository where users can store source code for use with AWS workflows. You must provide a location for the source code ZIP file in the AWS CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf. For more information about using a GitHub source repository with AWS CodeStar projects, see AWS CodeStar Project Files and Resources: https://docs.aws.amazon.com/codestar/latest/userguide/templates.html#templates-whatis. .DESCRIPTION - Adds an AWS::CodeStar::GitHubRepository resource to the template. + Adds an AWS::CodeStar::GitHubRepository resource to the template. The AWS::CodeStar::GitHubRepository resource creates a GitHub repository where users can store source code for use with AWS workflows. You must provide a location for the source code ZIP file in the AWS CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf. For more information about using a GitHub source repository with AWS CodeStar projects, see AWS CodeStar Project Files and Resources: https://docs.aws.amazon.com/codestar/latest/userguide/templates.html#templates-whatis. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html @@ -13,36 +13,50 @@ function New-VSCodeStarGitHubRepository { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EnableIssues + Indicates whether to enable issues for the GitHub repository. You can use GitHub issues to track information and bugs for your repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-enableissues PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RepositoryName + The name of the repository you want to create in GitHub with AWS CloudFormation stack creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryname PrimitiveType: String UpdateType: Mutable .PARAMETER RepositoryAccessToken + The GitHub user's personal access token for the GitHub repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryaccesstoken PrimitiveType: String UpdateType: Mutable .PARAMETER RepositoryOwner + The GitHub user name for the owner of the GitHub repository to be created. If this repository should be owned by a GitHub organization, provide its name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryowner PrimitiveType: String UpdateType: Mutable .PARAMETER IsPrivate + Indicates whether the GitHub repository is a private repository. If so, you choose who can see and commit to this repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-isprivate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Code + Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. + Type: Code Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-code UpdateType: Mutable .PARAMETER RepositoryDescription + A comment or description about the new repository. This description is displayed in GitHub after the repository is created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositorydescription PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 index 785651d8c..89ab5e448 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoIdentityPool { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPool resource to the template. + Adds an AWS::Cognito::IdentityPool resource to the template. The AWS::Cognito::IdentityPool resource creates an Amazon Cognito identity pool. .DESCRIPTION - Adds an AWS::Cognito::IdentityPool resource to the template. + Adds an AWS::Cognito::IdentityPool resource to the template. The AWS::Cognito::IdentityPool resource creates an Amazon Cognito identity pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html @@ -13,59 +13,86 @@ function New-VSCognitoIdentityPool { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PushSync + Configuration options to be applied to the identity pool. + Type: PushSync Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-pushsync UpdateType: Mutable .PARAMETER CognitoIdentityProviders + An array of Amazon Cognito user pools and their client IDs. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoidentityproviders ItemType: CognitoIdentityProvider UpdateType: Mutable .PARAMETER CognitoEvents + The events to configure. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoevents PrimitiveType: Json UpdateType: Mutable .PARAMETER DeveloperProviderName + The "domain" by which Amazon Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters and periods ., underscores _, and dashes -. +*Minimum length*: 1 +*Maximum length*: 100 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-developerprovidername PrimitiveType: String UpdateType: Mutable .PARAMETER CognitoStreams + Configuration options for configuring Amazon Cognito streams. + Type: CognitoStreams Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitostreams UpdateType: Mutable .PARAMETER IdentityPoolName + The name of your Amazon Cognito identity pool. +*Minimum length*: 1 +*Maximum length*: 128 +*Pattern*: w ]+ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypoolname PrimitiveType: String UpdateType: Mutable .PARAMETER AllowUnauthenticatedIdentities + Specifies whether the identity pool supports unauthenticated logins. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowunauthenticatedidentities PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SupportedLoginProviders + Key-value pairs that map provider names to provider app IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-supportedloginproviders PrimitiveType: Json UpdateType: Mutable .PARAMETER SamlProviderARNs + A list of Amazon Resource Names ARNs of Security Assertion Markup Language SAML providers. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-samlproviderarns UpdateType: Mutable .PARAMETER OpenIdConnectProviderARNs + A list of ARNs for the OpendID Connect provider. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-openidconnectproviderarns UpdateType: Mutable .PARAMETER AllowClassicFlow + The name of the Amazon Cognito identity pool, returned as a string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowclassicflow PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 index dd7860cd2..97fdea566 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoIdentityPoolRoleAttachment { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPoolRoleAttachment resource to the template. + Adds an AWS::Cognito::IdentityPoolRoleAttachment resource to the template. The AWS::Cognito::IdentityPoolRoleAttachment resource manages the role configuration for an Amazon Cognito identity pool. .DESCRIPTION - Adds an AWS::Cognito::IdentityPoolRoleAttachment resource to the template. + Adds an AWS::Cognito::IdentityPoolRoleAttachment resource to the template. The AWS::Cognito::IdentityPoolRoleAttachment resource manages the role configuration for an Amazon Cognito identity pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html @@ -13,16 +13,22 @@ function New-VSCognitoIdentityPoolRoleAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RoleMappings + How users for a specific identity provider are mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-rolemappings PrimitiveType: Json UpdateType: Mutable .PARAMETER IdentityPoolId + An identity pool ID in the format REGION:GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-identitypoolid PrimitiveType: String UpdateType: Immutable .PARAMETER Roles + The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-roles PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 index 5900d165e..a8b024870 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPool { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool resource to the template. + Adds an AWS::Cognito::UserPool resource to the template. The AWS::Cognito::UserPool resource creates an Amazon Cognito user pool. For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html and CreateUserPool: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html. .DESCRIPTION - Adds an AWS::Cognito::UserPool resource to the template. + Adds an AWS::Cognito::UserPool resource to the template. The AWS::Cognito::UserPool resource creates an Amazon Cognito user pool. For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html and CreateUserPool: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html @@ -13,111 +13,166 @@ function New-VSCognitoUserPool { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER UserPoolTags + The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags PrimitiveType: Json UpdateType: Mutable .PARAMETER Policies + The policy associated with a user pool. + Type: Policies Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies UpdateType: Mutable .PARAMETER VerificationMessageTemplate + The template for the verification message that the user sees when the app requests permission to access the user's information. + Type: VerificationMessageTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate UpdateType: Mutable .PARAMETER MfaConfiguration + Specifies multi-factor authentication MFA configuration details. Can be one of the following values: +OFF - MFA tokens are not required and cannot be specified during user registration. +ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. +OPTIONAL - Users have the option when registering to create an MFA token. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration PrimitiveType: String UpdateType: Mutable .PARAMETER Schema + An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema ItemType: SchemaAttribute UpdateType: Mutable .PARAMETER AdminCreateUserConfig + The type of configuration for creating a new user profile. + Type: AdminCreateUserConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig UpdateType: Mutable .PARAMETER SmsAuthenticationMessage + A string representing the SMS authentication message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage PrimitiveType: String UpdateType: Mutable + .PARAMETER UsernameConfiguration + The URL of the provider of the Amazon Cognito user pool, specified as a String. + + Type: UsernameConfiguration + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration + UpdateType: Mutable + .PARAMETER UserPoolName + A string used to name the user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname PrimitiveType: String UpdateType: Mutable .PARAMETER SmsVerificationMessage + A string representing the SMS verification message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolAddOns + Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT". + Type: UserPoolAddOns Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons UpdateType: Mutable .PARAMETER EmailConfiguration + The email configuration. + Type: EmailConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration UpdateType: Mutable .PARAMETER SmsConfiguration + The SMS configuration. + Type: SmsConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration UpdateType: Mutable .PARAMETER AliasAttributes + Attributes supported as an alias for this user pool. Possible values: **phone_number**, **email**, or **preferred_username**. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes UpdateType: Mutable .PARAMETER EnabledMfas + The URL of the provider of the Amazon Cognito user pool, specified as a String. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas UpdateType: Mutable .PARAMETER EmailVerificationSubject + A string representing the email verification subject. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaConfig + The Lambda trigger configuration information for the new user pool. +In a push model, event sources such as Amazon S3 and custom applications need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function. +For more information on using the Lambda API to add permission, see AddPermission : https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html. +For adding permission using the AWS CLI, see add-permission : https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html. + Type: LambdaConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig UpdateType: Mutable .PARAMETER UsernameAttributes + Specifies whether email addresses or phone numbers can be specified as user names when a user signs up. Possible values: phone_number or email. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes UpdateType: Mutable .PARAMETER AutoVerifiedAttributes + The attributes to be auto-verified. Possible values: **email**, **phone_number**. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes UpdateType: Mutable .PARAMETER DeviceConfiguration + The type of configuration for the user pool's device tracking. + Type: DeviceConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration UpdateType: Mutable .PARAMETER EmailVerificationMessage + A string representing the email verification message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage PrimitiveType: String UpdateType: Mutable .PARAMETER AccountRecoverySetting + The URL of the provider of the Amazon Cognito user pool, specified as a String. + Type: AccountRecoverySetting Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting UpdateType: Mutable @@ -218,6 +273,8 @@ function New-VSCognitoUserPool { })] $SmsAuthenticationMessage, [parameter(Mandatory = $false)] + $UsernameConfiguration, + [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 index 1c6ce37cb..4e25fd5a4 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolClient { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolClient resource to the template. + Adds an AWS::Cognito::UserPoolClient resource to the template. The AWS::Cognito::UserPoolClient resource creates an Amazon Cognito user pool client. .DESCRIPTION - Adds an AWS::Cognito::UserPoolClient resource to the template. + Adds an AWS::Cognito::UserPoolClient resource to the template. The AWS::Cognito::UserPoolClient resource creates an Amazon Cognito user pool client. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html @@ -13,89 +13,137 @@ function New-VSCognitoUserPoolClient { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AnalyticsConfiguration + The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. + Type: AnalyticsConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration UpdateType: Mutable .PARAMETER GenerateSecret + Boolean to specify whether you want to generate a secret for the user pool client being created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret PrimitiveType: Boolean UpdateType: Immutable .PARAMETER CallbackURLs + A list of allowed redirect callback URLs for the identity providers. +A redirect URI must: ++ Be an absolute URI. ++ Be registered with the authorization server. ++ Not include a fragment component. +See OAuth 2.0 - Redirection Endpoint: https://tools.ietf.org/html/rfc6749#section-3.1.2. +Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. +App callback URLs such as myapp://example are also supported. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-callbackurls UpdateType: Mutable .PARAMETER AllowedOAuthScopes + A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes UpdateType: Mutable .PARAMETER ReadAttributes + The read attributes. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes UpdateType: Mutable .PARAMETER AllowedOAuthFlowsUserPoolClient + Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultRedirectURI + The default redirect URI. Must be in the CallbackURLs list. +A redirect URI must: ++ Be an absolute URI. ++ Be registered with the authorization server. ++ Not include a fragment component. +See OAuth 2.0 - Redirection Endpoint: https://tools.ietf.org/html/rfc6749#section-3.1.2. +Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. +App callback URLs such as myapp://example are also supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-defaultredirecturi PrimitiveType: String UpdateType: Mutable .PARAMETER SupportedIdentityProviders + A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders UpdateType: Mutable .PARAMETER ClientName + The client name for the user pool client you would like to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-clientname PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId + The user pool ID for the user pool where you want to create a user pool client. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER AllowedOAuthFlows + Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. +Set to token to specify that the client should get the access token and, optionally, ID token, based on scopes directly. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflows UpdateType: Mutable .PARAMETER ExplicitAuthFlows + The explicit authentication flows, which can be one of the following: ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-explicitauthflows UpdateType: Mutable .PARAMETER LogoutURLs + A list of allowed logout URLs for the identity providers. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-logouturls UpdateType: Mutable .PARAMETER RefreshTokenValidity + The time limit, in days, after which the refresh token is no longer valid and cannot be used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenvalidity PrimitiveType: Integer UpdateType: Mutable .PARAMETER WriteAttributes + The user pool attributes that the app client can write to. +If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes UpdateType: Mutable .PARAMETER PreventUserExistenceErrors + For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-preventuserexistenceerrors PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 index 098948153..32317a1f4 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolGroup { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolGroup resource to the template. + Adds an AWS::Cognito::UserPoolGroup resource to the template. The AWS::Cognito::UserPoolGroup resource creates a user group in an Amazon Cognito user pool. .DESCRIPTION - Adds an AWS::Cognito::UserPoolGroup resource to the template. + Adds an AWS::Cognito::UserPoolGroup resource to the template. The AWS::Cognito::UserPoolGroup resource creates a user group in an Amazon Cognito user pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html @@ -13,26 +13,38 @@ function New-VSCognitoUserPoolGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GroupName + The name of the group. Must be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A string containing the description of the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId + The user pool ID for the user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER Precedence + A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. +Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens. +The default Precedence value is null. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence PrimitiveType: Double UpdateType: Mutable .PARAMETER RoleArn + The role ARN for the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 index 36d1dc3b3..e7f7ff3be 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolUser { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolUser resource to the template. + Adds an AWS::Cognito::UserPoolUser resource to the template. The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user. .DESCRIPTION - Adds an AWS::Cognito::UserPoolUser resource to the template. + Adds an AWS::Cognito::UserPoolUser resource to the template. The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html @@ -13,43 +13,68 @@ function New-VSCognitoUserPoolUser { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ValidationData + The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. +To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. +The user's validation data is not persisted. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata ItemType: AttributeType UpdateType: Immutable .PARAMETER UserPoolId + The user pool ID for the user pool where the user will be created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER Username + The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username PrimitiveType: String UpdateType: Immutable .PARAMETER MessageAction + Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction PrimitiveType: String UpdateType: Immutable .PARAMETER ClientMetadata + For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata PrimitiveType: Json UpdateType: Immutable .PARAMETER DesiredDeliveryMediums + Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums UpdateType: Immutable .PARAMETER ForceAliasCreation + This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. +If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. +If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation PrimitiveType: Boolean UpdateType: Immutable .PARAMETER UserAttributes + An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required in https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html or in the **Attributes** tab of the console must be supplied either by you in your call to AdminCreateUser or by the user when he or she signs up in response to your welcome message. +For custom attributes, you must prepend the custom: prefix to the attribute name. +To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the **Users** tab of the Amazon Cognito console for managing your user pools. +In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html. ++ **email**: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. ++ **phone_number**: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes ItemType: AttributeType diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 index 514738c68..7f9289545 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolUserToGroupAttachment { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. + Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. The AWS::Cognito::UserPoolUserToGroupAttachment resource attaches a user to an Amazon Cognito user pool user group. .DESCRIPTION - Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. + Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. The AWS::Cognito::UserPoolUserToGroupAttachment resource attaches a user to an Amazon Cognito user pool user group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html @@ -13,16 +13,22 @@ function New-VSCognitoUserPoolUserToGroupAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GroupName + The group name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-groupname PrimitiveType: String UpdateType: Immutable .PARAMETER UserPoolId + The user pool ID for the user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER Username + The username for the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-username PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 b/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 index 9bf6ce9a5..8b62930ff 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 @@ -1,10 +1,10 @@ function New-VSConfigAggregationAuthorization { <# .SYNOPSIS - Adds an AWS::Config::AggregationAuthorization resource to the template. + Adds an AWS::Config::AggregationAuthorization resource to the template. An object that represents the authorizations granted to aggregator accounts and regions. .DESCRIPTION - Adds an AWS::Config::AggregationAuthorization resource to the template. + Adds an AWS::Config::AggregationAuthorization resource to the template. An object that represents the authorizations granted to aggregator accounts and regions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html @@ -13,15 +13,25 @@ function New-VSConfigAggregationAuthorization { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AuthorizedAccountId + The 12-digit account ID of the account authorized to aggregate data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#cfn-config-aggregationauthorization-authorizedaccountid PrimitiveType: String UpdateType: Immutable .PARAMETER AuthorizedAwsRegion + The region authorized to collect aggregated data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#cfn-config-aggregationauthorization-authorizedawsregion PrimitiveType: String UpdateType: Immutable + .PARAMETER Tags + Type: List + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#cfn-config-aggregationauthorization-tags + ItemType: Tag + UpdateType: Mutable + .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. @@ -89,6 +99,17 @@ function New-VSConfigAggregationAuthorization { } })] $AuthorizedAwsRegion, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, @@ -146,6 +167,12 @@ function New-VSConfigAggregationAuthorization { Condition { $ResourceParams.Add("Condition",$Condition) } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 index 8390e580d..dbda7615f 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 @@ -1,10 +1,26 @@ function New-VSConfigConfigRule { <# .SYNOPSIS - Adds an AWS::Config::ConfigRule resource to the template. + Adds an AWS::Config::ConfigRule resource to the template. Specifies an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. .DESCRIPTION - Adds an AWS::Config::ConfigRule resource to the template. + Adds an AWS::Config::ConfigRule resource to the template. Specifies an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. + +You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides. + +If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object. + +If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html. + +For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules. + +If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request. + +The maximum number of rules that AWS Config supports is 150. + +For information about requesting a rule limit increase, see AWS Config Limits: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config in the *AWS General Reference Guide*. + +For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html in the *AWS Config Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html @@ -13,31 +29,46 @@ function New-VSConfigConfigRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConfigRuleName + A name for the AWS Config rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-configrulename PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description that you provide for the AWS Config rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-description PrimitiveType: String UpdateType: Mutable .PARAMETER InputParameters + A string, in JSON format, that is passed to the AWS Config rule Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-inputparameters PrimitiveType: Json UpdateType: Mutable .PARAMETER MaximumExecutionFrequency + The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when: ++ You are using an AWS managed rule that is triggered at a periodic frequency. ++ Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties: https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html. +By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-maximumexecutionfrequency PrimitiveType: String UpdateType: Mutable .PARAMETER Scope + Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-scope Type: Scope UpdateType: Mutable .PARAMETER Source + Provides the rule owner AWS or customer, the rule identifier, and the notifications that cause the function to evaluate your AWS resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-source Type: Source UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 index 9ea89958e..58da2e9b8 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 @@ -1,10 +1,10 @@ function New-VSConfigConfigurationAggregator { <# .SYNOPSIS - Adds an AWS::Config::ConfigurationAggregator resource to the template. + Adds an AWS::Config::ConfigurationAggregator resource to the template. The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator. .DESCRIPTION - Adds an AWS::Config::ConfigurationAggregator resource to the template. + Adds an AWS::Config::ConfigurationAggregator resource to the template. The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html @@ -13,21 +13,33 @@ function New-VSConfigConfigurationAggregator { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccountAggregationSources + Provides a list of source accounts and regions to be aggregated. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-accountaggregationsources ItemType: AccountAggregationSource UpdateType: Mutable .PARAMETER ConfigurationAggregatorName + The name of the aggregator. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-configurationaggregatorname PrimitiveType: String UpdateType: Immutable .PARAMETER OrganizationAggregationSource + Provides an organization and list of regions to be aggregated. + Type: OrganizationAggregationSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-organizationaggregationsource UpdateType: Mutable + .PARAMETER Tags + Type: List + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-tags + ItemType: Tag + UpdateType: Mutable + .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. @@ -97,6 +109,17 @@ function New-VSConfigConfigurationAggregator { $ConfigurationAggregatorName, [parameter(Mandatory = $false)] $OrganizationAggregationSource, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, @@ -160,6 +183,12 @@ function New-VSConfigConfigurationAggregator { } $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name AccountAggregationSources -Value @($AccountAggregationSources) } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 index 785ada81d..749d0e7c6 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 @@ -1,10 +1,16 @@ function New-VSConfigConfigurationRecorder { <# .SYNOPSIS - Adds an AWS::Config::ConfigurationRecorder resource to the template. + Adds an AWS::Config::ConfigurationRecorder resource to the template. The AWS::Config::ConfigurationRecorder resource describes the AWS resource types for which AWS Config records configuration changes. The configuration recorder stores the configurations of the supported resources in your account as configuration items. .DESCRIPTION - Adds an AWS::Config::ConfigurationRecorder resource to the template. + Adds an AWS::Config::ConfigurationRecorder resource to the template. The AWS::Config::ConfigurationRecorder resource describes the AWS resource types for which AWS Config records configuration changes. The configuration recorder stores the configurations of the supported resources in your account as configuration items. + +**Note** + +To enable AWS Config, you must create a configuration recorder and a delivery channel. AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon SNS topic. For more information, see AWS::Config::DeliveryChannel: https://docs.aws.amazon.com/config/latest/UserGuide/aws-resource-config-deliverychannel.html. + +AWS CloudFormation starts the recorder as soon as the delivery channel is available. To stop the recorder, delete the configuration recorder from your stack. For more information, see Configuration Recorder: https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#config-recorder in the AWS Config Developer Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html @@ -13,16 +19,24 @@ function New-VSConfigConfigurationRecorder { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + A name for the configuration recorder. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the configuration recorder name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +After you create a configuration recorder, you cannot rename it. If you don't want a name that AWS CloudFormation generates, specify a value for this property. +Updates are not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-name PrimitiveType: String UpdateType: Immutable .PARAMETER RecordingGroup + Indicates whether to record configurations for all supported resources or for a list of resource types. The resource types that you list must be supported by AWS Config. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-recordinggroup Type: RecordingGroup UpdateType: Mutable .PARAMETER RoleARN + The Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that is used to make read or write requests to the delivery channel that you specify and to get configuration details for supported AWS resources. For more information, see Permissions for the IAM Role Assigned: https://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html to AWS Config in the AWS Config Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 b/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 index 8217cc55f..81082de25 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 @@ -1,10 +1,26 @@ function New-VSConfigDeliveryChannel { <# .SYNOPSIS - Adds an AWS::Config::DeliveryChannel resource to the template. + Adds an AWS::Config::DeliveryChannel resource to the template. Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. .DESCRIPTION - Adds an AWS::Config::DeliveryChannel resource to the template. + Adds an AWS::Config::DeliveryChannel resource to the template. Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. + +Before you can create a delivery channel, you must create a configuration recorder. + +You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. + +**Note** + +You can have only one delivery channel per region in your account. + +When you create the delivery channel, you can specify; how often AWS Config delivers configuration snapshots to your Amazon S3 bucket (for example, 24 hours, the S3 bucket to which AWS Config sends configuration snapshots and configuration history files, and the Amazon SNS topic to which AWS Config sends notifications about configuration changes, such as updated resources, AWS Config rule evaluations, and when AWS Config delivers the configuration snapshot to your S3 bucket. For more information, see Deliver Configuration Items: https://docs.aws.amazon.com/config/latest/developerguide/how-does-config-work.html#delivery-channel in the AWS Config Developer Guide. + +**Note** + +To enable AWS Config, you must create a configuration recorder and a delivery channel. If you want to create the resources separately, you must create a configuration recorder before you can create a delivery channel. AWS Config uses the configuration recorder to capture configuration changes to your resources. For more information, see AWS::Config::ConfigurationRecorder: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html. + +For more information, see Managing the Delivery Channel: https://docs.aws.amazon.com/config/latest/developerguide/manage-delivery-channel.html in the AWS Config Developer Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html @@ -13,26 +29,39 @@ function New-VSConfigDeliveryChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConfigSnapshotDeliveryProperties + The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties Type: ConfigSnapshotDeliveryProperties UpdateType: Mutable .PARAMETER Name + A name for the delivery channel. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the delivery channel name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +Updates are not supported. To change the name, you must run two separate updates. In the first update, delete this resource, and then recreate it with a new name in the second update. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-name PrimitiveType: String UpdateType: Immutable .PARAMETER S3BucketName + The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. +If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket: https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html in the AWS Config Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3bucketname PrimitiveType: String UpdateType: Mutable .PARAMETER S3KeyPrefix + The prefix for the specified Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3keyprefix PrimitiveType: String UpdateType: Mutable .PARAMETER SnsTopicARN + The Amazon Resource Name ARN of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. +If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic: https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html in the AWS Config Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-snstopicarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 index 87eed12bb..4f55d3403 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 @@ -1,10 +1,12 @@ function New-VSConfigOrganizationConfigRule { <# .SYNOPSIS - Adds an AWS::Config::OrganizationConfigRule resource to the template. + Adds an AWS::Config::OrganizationConfigRule resource to the template. An organization config rule that has information about config rules that AWS Config creates in member accounts. Only a master account can create or update an organization config rule. .DESCRIPTION - Adds an AWS::Config::OrganizationConfigRule resource to the template. + Adds an AWS::Config::OrganizationConfigRule resource to the template. An organization config rule that has information about config rules that AWS Config creates in member accounts. Only a master account can create or update an organization config rule. + +OrganizationConfigRule resource enables organization service access through EnableAWSServiceAccess action and creates a service linked role in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with GetRole action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html @@ -13,21 +15,29 @@ function New-VSConfigOrganizationConfigRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OrganizationManagedRuleMetadata + An OrganizationManagedRuleMetadata object. + Type: OrganizationManagedRuleMetadata Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata UpdateType: Mutable .PARAMETER OrganizationConfigRuleName + The name that you assign to organization config rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationconfigrulename PrimitiveType: String UpdateType: Immutable .PARAMETER OrganizationCustomRuleMetadata + An OrganizationCustomRuleMetadata object. + Type: OrganizationCustomRuleMetadata Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata UpdateType: Mutable .PARAMETER ExcludedAccounts + A comma-separated list of accounts excluded from organization config rule. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-excludedaccounts diff --git a/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 index 37d3fa18d..c7159e93d 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 @@ -1,10 +1,10 @@ function New-VSConfigRemediationConfiguration { <# .SYNOPSIS - Adds an AWS::Config::RemediationConfiguration resource to the template. + Adds an AWS::Config::RemediationConfiguration resource to the template. An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action. .DESCRIPTION - Adds an AWS::Config::RemediationConfiguration resource to the template. + Adds an AWS::Config::RemediationConfiguration resource to the template. An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html @@ -13,6 +13,8 @@ function New-VSConfigRemediationConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TargetVersion + Version of the target. For example, version of the SSM document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targetversion PrimitiveType: String UpdateType: Mutable @@ -23,21 +25,30 @@ function New-VSConfigRemediationConfiguration { UpdateType: Mutable .PARAMETER Parameters + An object of the RemediationParameterValue. +The type is a map of strings to RemediationParameterValue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER TargetType + The type of the target. Target executes remediation. For example, SSM document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targettype PrimitiveType: String UpdateType: Mutable .PARAMETER ConfigRuleName + The name of the AWS Config rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-configrulename PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceType + The type of a resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-resourcetype PrimitiveType: String UpdateType: Mutable @@ -53,6 +64,8 @@ function New-VSConfigRemediationConfiguration { UpdateType: Mutable .PARAMETER TargetId + Target ID is the name of the public document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 b/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 index e210b0130..7dafbb79d 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 @@ -1,10 +1,10 @@ function New-VSDAXCluster { <# .SYNOPSIS - Adds an AWS::DAX::Cluster resource to the template. + Adds an AWS::DAX::Cluster resource to the template. Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. .DESCRIPTION - Adds an AWS::DAX::Cluster resource to the template. + Adds an AWS::DAX::Cluster resource to the template. Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html @@ -13,68 +13,102 @@ function New-VSDAXCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SSESpecification + Represents the settings used to enable server-side encryption on the cluster. + Type: SSESpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-ssespecification UpdateType: Immutable .PARAMETER Description + The description of the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-description PrimitiveType: String UpdateType: Mutable .PARAMETER ReplicationFactor + The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set *ReplicationFactor* to 2 or more. +AWS recommends that you have at least two read replicas per cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-replicationfactor PrimitiveType: Integer UpdateType: Mutable .PARAMETER ParameterGroupName + The parameter group to be associated with the DAX cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-parametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER AvailabilityZones + The Availability Zones AZs in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-availabilityzones UpdateType: Mutable .PARAMETER IAMRoleARN + A valid Amazon Resource Name ARN that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf. +Updates are not supported for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-iamrolearn PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetGroupName + The name of the subnet group to be used for the replication group. +DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC. +Updates are not supported for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-subnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationTopicARN + The Amazon Resource Name ARN of the Amazon SNS topic to which notifications will be sent. +The Amazon SNS topic owner must be same as the DAX cluster owner. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-notificationtopicarn PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroupIds + A list of security group IDs to be assigned to each node in the DAX cluster. Each of the security group ID is system-generated. +If this parameter is not specified, DAX assigns the default VPC security group to each node. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-securitygroupids UpdateType: Mutable .PARAMETER NodeType + The node type for the nodes in the cluster. All nodes in a DAX cluster are of the same type. +Updates are not supported for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-nodetype PrimitiveType: String UpdateType: Immutable .PARAMETER ClusterName + The name of the DAX cluster. +Updates are not supported for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clustername PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + A set of tags to associate with the DAX cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 index 0d2fcde6c..497853a02 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 @@ -1,10 +1,10 @@ function New-VSDAXParameterGroup { <# .SYNOPSIS - Adds an AWS::DAX::ParameterGroup resource to the template. + Adds an AWS::DAX::ParameterGroup resource to the template. A named set of parameters that are applied to all of the nodes in a DAX cluster. .DESCRIPTION - Adds an AWS::DAX::ParameterGroup resource to the template. + Adds an AWS::DAX::ParameterGroup resource to the template. A named set of parameters that are applied to all of the nodes in a DAX cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html @@ -13,16 +13,22 @@ function New-VSDAXParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ParameterNameValues + An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-parameternamevalues PrimitiveType: Json UpdateType: Mutable .PARAMETER Description + A description of the parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER ParameterGroupName + The name of the parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-parametergroupname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 index f5dba9069..034cd1673 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSDAXSubnetGroup { <# .SYNOPSIS - Adds an AWS::DAX::SubnetGroup resource to the template. + Adds an AWS::DAX::SubnetGroup resource to the template. Creates a new subnet group. .DESCRIPTION - Adds an AWS::DAX::SubnetGroup resource to the template. + Adds an AWS::DAX::SubnetGroup resource to the template. Creates a new subnet group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html @@ -13,16 +13,22 @@ function New-VSDAXSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetGroupName + The name of the subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-subnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetIds + A list of VPC subnet IDs for the subnet group. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-subnetids diff --git a/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 index 4b986ebf7..055c366f7 100644 --- a/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 @@ -1,10 +1,12 @@ function New-VSDLMLifecyclePolicy { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy resource to the template. + Adds an AWS::DLM::LifecyclePolicy resource to the template. Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources. .DESCRIPTION - Adds an AWS::DLM::LifecyclePolicy resource to the template. + Adds an AWS::DLM::LifecyclePolicy resource to the template. Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources. + +The properties are required when you add a lifecycle policy and optional when you update a lifecycle policy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html @@ -13,21 +15,30 @@ function New-VSDLMLifecyclePolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ExecutionRoleArn + The Amazon Resource Name ARN of the IAM role used to run the operations specified by the lifecycle policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-executionrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the lifecycle policy. The characters ^0-9A-Za-z _-]+$ are supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-description PrimitiveType: String UpdateType: Mutable .PARAMETER State + The activation state of the lifecycle policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-state PrimitiveType: String UpdateType: Mutable .PARAMETER PolicyDetails + The configuration details of the lifecycle policy. +Target tags cannot be re-used across lifecycle policies. + Type: PolicyDetails Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-policydetails UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 index 831466112..9fe923ae7 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 @@ -1,10 +1,10 @@ function New-VSDMSCertificate { <# .SYNOPSIS - Adds an AWS::DMS::Certificate resource to the template. + Adds an AWS::DMS::Certificate resource to the template. The AWS::DMS::Certificate resource creates an SSL certificate that encrypts connections between AWS DMS endpoints and the replication instance. .DESCRIPTION - Adds an AWS::DMS::Certificate resource to the template. + Adds an AWS::DMS::Certificate resource to the template. The AWS::DMS::Certificate resource creates an SSL certificate that encrypts connections between AWS DMS endpoints and the replication instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html @@ -13,16 +13,22 @@ function New-VSDMSCertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CertificateIdentifier + The customer-assigned name of the certificate. Valid characters are A-z and 0-9. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificateidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER CertificatePem + The contents of the .pem X.509 certificate file for the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatepem PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateWallet + The location of the imported Oracle Wallet certificate for use with SSL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatewallet PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 index 0c1e97057..9195c0f73 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 @@ -1,10 +1,10 @@ function New-VSDMSEndpoint { <# .SYNOPSIS - Adds an AWS::DMS::Endpoint resource to the template. + Adds an AWS::DMS::Endpoint resource to the template. The AWS::DMS::Endpoint resource creates an AWS DMS endpoint. .DESCRIPTION - Adds an AWS::DMS::Endpoint resource to the template. + Adds an AWS::DMS::Endpoint resource to the template. The AWS::DMS::Endpoint resource creates an AWS DMS endpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html @@ -13,92 +13,128 @@ function New-VSDMSEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KmsKeyId + The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER Port + The port used by the endpoint database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER DatabaseName + The name of the endpoint database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER ElasticsearchSettings + Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration in the *AWS Database Migration User Guide.* + Type: ElasticsearchSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings UpdateType: Mutable .PARAMETER S3Settings + Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring in the *AWS Database Migration Service User Guide.* + Type: S3Settings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings UpdateType: Mutable .PARAMETER EngineName + The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename PrimitiveType: String UpdateType: Mutable .PARAMETER DynamoDbSettings + Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html in the *AWS Database Migration Service User Guide.* + Type: DynamoDbSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings UpdateType: Mutable .PARAMETER KinesisSettings + Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping in the *AWS Database Migration User Guide.* + Type: KinesisSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings UpdateType: Mutable .PARAMETER Username + The user name to be used to log in to the endpoint database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-username PrimitiveType: String UpdateType: Mutable .PARAMETER SslMode + The Secure Sockets Layer SSL mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode PrimitiveType: String UpdateType: Mutable .PARAMETER ServerName + The name of the server where the endpoint database resides. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-servername PrimitiveType: String UpdateType: Mutable .PARAMETER ExtraConnectionAttributes + Additional attributes associated with the connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes PrimitiveType: String UpdateType: Mutable .PARAMETER EndpointType + The type of endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + Tags to be added to the endpoint. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags ItemType: Tag UpdateType: Immutable .PARAMETER EndpointIdentifier + The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER Password + The password to be used to log in to the endpoint database. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-password PrimitiveType: String UpdateType: Mutable .PARAMETER CertificateArn + The Amazon Resource Name ARN for the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-certificatearn PrimitiveType: String UpdateType: Mutable .PARAMETER MongoDbSettings + Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html in the *AWS Database Migration Service User Guide.* + Type: MongoDbSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 index ea3ec1f66..421501544 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 @@ -1,10 +1,10 @@ function New-VSDMSEventSubscription { <# .SYNOPSIS - Adds an AWS::DMS::EventSubscription resource to the template. + Adds an AWS::DMS::EventSubscription resource to the template. Use the AWS::DMS::EventSubscription resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service. For more information, see Using AWS DMS Event Notification: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html in the *AWS Database Migration Service User Guide.* .DESCRIPTION - Adds an AWS::DMS::EventSubscription resource to the template. + Adds an AWS::DMS::EventSubscription resource to the template. Use the AWS::DMS::EventSubscription resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service. For more information, see Using AWS DMS Event Notification: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html in the *AWS Database Migration Service User Guide.* .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html @@ -13,38 +13,54 @@ function New-VSDMSEventSubscription { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SourceType + The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned. +Valid values: replication-instance | migration-task + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER EventCategories + A list of event categories for a source type that you want to subscribe to. If you don't specify this property, you are notified about all event categories. For more information, see Working with Events and Notifications: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html in the *AWS Database Migration Service User Guide.* + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-eventcategories UpdateType: Mutable .PARAMETER Enabled + Indicates whether to activate the subscription. If you don't specify this property, AWS CloudFormation activates the subscription. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SubscriptionName + The name of the AWS DMS event notification subscription. +Constraints: The name must be less than 255 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname PrimitiveType: String UpdateType: Immutable .PARAMETER SnsTopicArn + The Amazon Resource Name ARN of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-snstopicarn PrimitiveType: String UpdateType: Mutable .PARAMETER SourceIds + The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourceids UpdateType: Immutable .PARAMETER Tags + A tag to be attached to the event subscription. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 index 115cbbefe..cb8c4a4a0 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 @@ -1,10 +1,10 @@ function New-VSDMSReplicationInstance { <# .SYNOPSIS - Adds an AWS::DMS::ReplicationInstance resource to the template. + Adds an AWS::DMS::ReplicationInstance resource to the template. The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instance. .DESCRIPTION - Adds an AWS::DMS::ReplicationInstance resource to the template. + Adds an AWS::DMS::ReplicationInstance resource to the template. The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html @@ -13,72 +13,113 @@ function New-VSDMSReplicationInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ReplicationInstanceIdentifier + The replication instance identifier. This parameter is stored as a lowercase string. +Constraints: ++ Must contain from 1 to 63 alphanumeric characters or hyphens. ++ First character must be a letter. ++ Cannot end with a hyphen or contain two consecutive hyphens. +Example: myrepinstance + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER EngineVersion + The engine version number of the replication instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-engineversion PrimitiveType: String UpdateType: Mutable .PARAMETER KmsKeyId + The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZone + The Availability Zone that the replication instance will be created in. +The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for example: us-east-1d + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + The weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. +Format: ddd:hh24:mi-ddd:hh24:mi +Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. +Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun +Constraints: Minimum 30-minute window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade + Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. +Default: true + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-autominorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ReplicationSubnetGroupIdentifier + A subnet group to associate with the replication instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationsubnetgroupidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER AllocatedStorage + The amount of storage in gigabytes to be initially allocated for the replication instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allocatedstorage PrimitiveType: Integer UpdateType: Mutable .PARAMETER VpcSecurityGroupIds + Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-vpcsecuritygroupids UpdateType: Mutable .PARAMETER AllowMajorVersionUpgrade + Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. +Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allowmajorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ReplicationInstanceClass + The compute and memory capacity of the replication instance as specified by the replication instance class. +Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceclass PrimitiveType: String UpdateType: Mutable .PARAMETER PubliclyAccessible + Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-publiclyaccessible PrimitiveType: Boolean UpdateType: Immutable .PARAMETER MultiAZ + Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-multiaz PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Tags + Tags to be associated with the replication instance. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 index d3369bc77..9385ca467 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 @@ -1,10 +1,14 @@ function New-VSDMSReplicationSubnetGroup { <# .SYNOPSIS - Adds an AWS::DMS::ReplicationSubnetGroup resource to the template. + Adds an AWS::DMS::ReplicationSubnetGroup resource to the template. The AWS::DMS::ReplicationSubnetGroup resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. .DESCRIPTION - Adds an AWS::DMS::ReplicationSubnetGroup resource to the template. + Adds an AWS::DMS::ReplicationSubnetGroup resource to the template. The AWS::DMS::ReplicationSubnetGroup resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. + +**Note** + +Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. For more information, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.APIRole.html in the *AWS Database Migration Service User Guide.* .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html @@ -13,22 +17,30 @@ function New-VSDMSReplicationSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ReplicationSubnetGroupDescription + The description for the subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER ReplicationSubnetGroupIdentifier + The identifier for the replication subnet group. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetIds + The EC2 subnet IDs for the subnet group. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-subnetids UpdateType: Mutable .PARAMETER Tags + The tag to be assigned to the subnet group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 index a7cbd8fa0..333990c86 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 @@ -1,10 +1,10 @@ function New-VSDMSReplicationTask { <# .SYNOPSIS - Adds an AWS::DMS::ReplicationTask resource to the template. + Adds an AWS::DMS::ReplicationTask resource to the template. The AWS::DMS::ReplicationTask resource creates an AWS DMS replication task. .DESCRIPTION - Adds an AWS::DMS::ReplicationTask resource to the template. + Adds an AWS::DMS::ReplicationTask resource to the template. The AWS::DMS::ReplicationTask resource creates an AWS DMS replication task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html @@ -13,57 +13,89 @@ function New-VSDMSReplicationTask { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ReplicationTaskSettings + Overall settings for the task, in JSON format. For more information, see Task Settings: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html in the *AWS Database Migration User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings PrimitiveType: String UpdateType: Mutable .PARAMETER TableMappings + The table mappings for the task, in JSON format. For more information, see Table Mapping: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html in the *AWS Database Migration User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings PrimitiveType: String UpdateType: Mutable .PARAMETER CdcStartPosition + Indicates when you want a change data capture CDC operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. +The value can be in date, checkpoint, or LSN/SCN format. +Date Example: --cdc-start-position “2018-03-08T12:12:12” +Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" +LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition PrimitiveType: String UpdateType: Mutable .PARAMETER ReplicationTaskIdentifier + An identifier for the replication task. +Constraints: ++ Must contain from 1 to 255 alphanumeric characters or hyphens. ++ First character must be a letter. ++ Cannot end with a hyphen or contain two consecutive hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER CdcStopPosition + Indicates when you want a change data capture CDC operation to stop. The value can be either server time or commit time. +Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” +Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition PrimitiveType: String UpdateType: Mutable .PARAMETER SourceEndpointArn + An Amazon Resource Name ARN that uniquely identifies the source endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn PrimitiveType: String UpdateType: Immutable .PARAMETER MigrationType + The migration type. Valid values: full-load | cdc | full-load-and-cdc + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype PrimitiveType: String UpdateType: Mutable .PARAMETER TargetEndpointArn + An Amazon Resource Name ARN that uniquely identifies the target endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn PrimitiveType: String UpdateType: Immutable .PARAMETER ReplicationInstanceArn + The Amazon Resource Name ARN of a replication instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + One or more tags to be assigned to the replication task. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags ItemType: Tag UpdateType: Immutable .PARAMETER CdcStartTime + Indicates the start time for a change data capture CDC operation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 b/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 index 6e6409456..3f01f346b 100644 --- a/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 @@ -1,10 +1,24 @@ function New-VSDataPipelinePipeline { <# .SYNOPSIS - Adds an AWS::DataPipeline::Pipeline resource to the template. + Adds an AWS::DataPipeline::Pipeline resource to the template. The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data. In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. For information about pipeline objects and components that you can use, see Pipeline Object Reference: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html in the *AWS Data Pipeline Developer Guide*. .DESCRIPTION - Adds an AWS::DataPipeline::Pipeline resource to the template. + Adds an AWS::DataPipeline::Pipeline resource to the template. The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data. In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. For information about pipeline objects and components that you can use, see Pipeline Object Reference: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html in the *AWS Data Pipeline Developer Guide*. + +The AWS::DataPipeline::Pipeline resource adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. + +PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following validation errors exist in the pipeline. + ++ An object is missing a name or identifier field. + ++ A string or reference field is empty. + ++ The number of objects in the pipeline exceeds the allowed maximum number of objects. + ++ The pipeline is in a FINISHED state. + +Pipeline object definitions are passed to the PutPipelineDefinition: https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html action and returned by the GetPipelineDefinition: https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html @@ -13,21 +27,29 @@ function New-VSDataPipelinePipeline { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Activate + Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-activate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Description + A description of the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-description PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-name PrimitiveType: String UpdateType: Immutable .PARAMETER ParameterObjects + The parameter objects used with the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parameterobjects DuplicatesAllowed: True ItemType: ParameterObject @@ -35,6 +57,8 @@ function New-VSDataPipelinePipeline { UpdateType: Mutable .PARAMETER ParameterValues + The parameter values used with the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parametervalues DuplicatesAllowed: True ItemType: ParameterValue @@ -42,6 +66,8 @@ function New-VSDataPipelinePipeline { UpdateType: Mutable .PARAMETER PipelineObjects + The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html in the *AWS Data Pipeline Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelineobjects DuplicatesAllowed: True ItemType: PipelineObject @@ -49,6 +75,8 @@ function New-VSDataPipelinePipeline { UpdateType: Mutable .PARAMETER PipelineTags + A list of arbitrary tags key-value pairs to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html in the *AWS Data Pipeline Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelinetags DuplicatesAllowed: True ItemType: PipelineTag diff --git a/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 b/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 index fa32bb5b0..6f66a8546 100644 --- a/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 @@ -1,10 +1,10 @@ function New-VSDirectoryServiceMicrosoftAD { <# .SYNOPSIS - Adds an AWS::DirectoryService::MicrosoftAD resource to the template. + Adds an AWS::DirectoryService::MicrosoftAD resource to the template. The AWS::DirectoryService::MicrosoftAD resource specifies a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. For more information, see AWS Managed Microsoft AD: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html in the *AWS Directory Service Admin Guide*. .DESCRIPTION - Adds an AWS::DirectoryService::MicrosoftAD resource to the template. + Adds an AWS::DirectoryService::MicrosoftAD resource to the template. The AWS::DirectoryService::MicrosoftAD resource specifies a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. For more information, see AWS Managed Microsoft AD: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html in the *AWS Directory Service Admin Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html @@ -13,36 +13,51 @@ function New-VSDirectoryServiceMicrosoftAD { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CreateAlias + Specifies an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://.awsapps.com. By default, AWS CloudFormation does not create an alias. +After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-createalias PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Edition + AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition PrimitiveType: String UpdateType: Immutable .PARAMETER EnableSso + Whether to enable single sign-on for a Microsoft Active Directory in AWS. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don't specify a value, AWS CloudFormation disables single sign-on by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-enablesso PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name PrimitiveType: String UpdateType: Immutable .PARAMETER Password + The password for the default administrative user named Admin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password PrimitiveType: String UpdateType: Immutable .PARAMETER ShortName + The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname PrimitiveType: String UpdateType: Immutable .PARAMETER VpcSettings + Specifies the VPC settings of the Microsoft AD directory server in AWS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-vpcsettings Type: VpcSettings UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 b/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 index 139d7f5c6..91f125917 100644 --- a/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 @@ -1,10 +1,10 @@ function New-VSDirectoryServiceSimpleAD { <# .SYNOPSIS - Adds an AWS::DirectoryService::SimpleAD resource to the template. + Adds an AWS::DirectoryService::SimpleAD resource to the template. The AWS::DirectoryService::SimpleAD resource specifies an AWS Directory Service Simple Active Directory (Simple AD in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. Simple AD is a Microsoft Active Directory–compatible directory. For more information, see Simple Active Directory: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html in the *AWS Directory Service Admin Guide*. .DESCRIPTION - Adds an AWS::DirectoryService::SimpleAD resource to the template. + Adds an AWS::DirectoryService::SimpleAD resource to the template. The AWS::DirectoryService::SimpleAD resource specifies an AWS Directory Service Simple Active Directory (Simple AD in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. Simple AD is a Microsoft Active Directory–compatible directory. For more information, see Simple Active Directory: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html in the *AWS Directory Service Admin Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html @@ -13,41 +13,58 @@ function New-VSDirectoryServiceSimpleAD { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CreateAlias + If set to true, specifies an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://.awsapps.com. By default, this property is set to false. +After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Description + A textual description for the directory. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description PrimitiveType: String UpdateType: Immutable .PARAMETER EnableSso + Whether to enable single sign-on for a directory. If you don't specify a value, AWS CloudFormation disables single sign-on by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The fully qualified name for the directory, such as corp.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name PrimitiveType: String UpdateType: Immutable .PARAMETER Password + The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password PrimitiveType: String UpdateType: Immutable .PARAMETER ShortName + The short name of the directory, such as CORP. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname PrimitiveType: String UpdateType: Immutable .PARAMETER Size + The size of the directory. For valid values, see CreateDirectory: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html in the *AWS Directory Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size PrimitiveType: String UpdateType: Immutable .PARAMETER VpcSettings + A DirectoryVpcSettings: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html object that contains additional information for the operation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings Type: VpcSettings UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 index 678e656ea..a2bbe4183 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 @@ -1,10 +1,10 @@ function New-VSDocDBDBCluster { <# .SYNOPSIS - Adds an AWS::DocDB::DBCluster resource to the template. + Adds an AWS::DocDB::DBCluster resource to the template. The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html in the *Amazon DocumentDB Developer Guide*. .DESCRIPTION - Adds an AWS::DocDB::DBCluster resource to the template. + Adds an AWS::DocDB::DBCluster resource to the template. The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html in the *Amazon DocumentDB Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html @@ -13,89 +13,157 @@ function New-VSDocDBDBCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER StorageEncrypted + Specifies whether the DB cluster is encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted PrimitiveType: Boolean UpdateType: Immutable .PARAMETER EngineVersion + The version number of the database engine to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion PrimitiveType: String UpdateType: Immutable .PARAMETER KmsKeyId + The AWS KMS key identifier for an encrypted DB cluster. +The AWS KMS key identifier is the Amazon Resource Name ARN for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. +If an encryption key is not specified in KmsKeyId: ++ If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. ++ If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key. +AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. +If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZones + A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones UpdateType: Immutable .PARAMETER SnapshotIdentifier + The identifier for the DB snapshot or DB cluster snapshot to restore from. +You can use either the name or the Amazon Resource Name ARN to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. +Constraints: ++ Must match the identifier of an existing snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER Port + Specifies the port that the database engine is listening on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER DBClusterIdentifier + The DB cluster identifier. This parameter is stored as a lowercase string. +Constraints: ++ Must contain from 1 to 63 letters, numbers, or hyphens. ++ The first character must be a letter. ++ Cannot end with a hyphen or contain two consecutive hyphens. +Example: my-cluster + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + The weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. +Format: ddd:hh24:mi-ddd:hh24:mi +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. +Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun +Constraints: Minimum 30-minute window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER DBSubnetGroupName + A DB subnet group to associate with this DB cluster. +Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. +Example: mySubnetgroup + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredBackupWindow + The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. +Constraints: ++ Must be in the format hh24:mi-hh24:mi. ++ Must be in Universal Coordinated Time UTC. ++ Must not conflict with the preferred maintenance window. ++ Must be at least 30 minutes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUserPassword + The password for the master database user. This password can contain any printable ASCII character except forward slash /, double quote ", or the "at" symbol @. +Constraints: Must contain from 8 to 41 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword PrimitiveType: String UpdateType: Mutable .PARAMETER VpcSecurityGroupIds + A list of EC2 VPC security groups to associate with this DB cluster. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids UpdateType: Mutable .PARAMETER MasterUsername + The name of the master user for the DB cluster. +Constraints: ++ Must be from 1 to 16 letters or numbers. ++ The first character must be a letter. ++ Cannot be a reserved word for the chosen database engine. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername PrimitiveType: String UpdateType: Immutable .PARAMETER DBClusterParameterGroupName + The name of the DB cluster parameter group to associate with this DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER BackupRetentionPeriod + The number of days for which automated backups are retained. You must specify a minimum value of 1. +Default: 1 +Constraints: ++ Must be a value from 1 to 35. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tags + The tags to be assigned to the DB cluster. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags ItemType: Tag UpdateType: Mutable .PARAMETER EnableCloudwatchLogsExports + + ModifyDBCluster: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 index 6d5c09dcf..96e78859f 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 @@ -1,10 +1,18 @@ function New-VSDocDBDBClusterParameterGroup { <# .SYNOPSIS - Adds an AWS::DocDB::DBClusterParameterGroup resource to the template. + Adds an AWS::DocDB::DBClusterParameterGroup resource to the template. The AWS::DocDB::DBClusterParameterGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBClusterParameterGroup. For more information, see DBClusterParameterGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html in the *Amazon DocumentDB Developer Guide*. .DESCRIPTION - Adds an AWS::DocDB::DBClusterParameterGroup resource to the template. + Adds an AWS::DocDB::DBClusterParameterGroup resource to the template. The AWS::DocDB::DBClusterParameterGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBClusterParameterGroup. For more information, see DBClusterParameterGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html in the *Amazon DocumentDB Developer Guide*. + +Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. + +A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover. + +**Important** + +After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html @@ -13,27 +21,40 @@ function New-VSDocDBDBClusterParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description for the DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + Provides a list of parameters for the DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER Family + The DB cluster parameter group family name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-family PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags to be assigned to the DB cluster parameter group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name of the DB cluster parameter group. +Constraints: ++ Must match the name of an existing DBClusterParameterGroup. +This value is stored as a lowercase string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 index 9e5571a53..c0d68df78 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 @@ -1,10 +1,10 @@ function New-VSDocDBDBInstance { <# .SYNOPSIS - Adds an AWS::DocDB::DBInstance resource to the template. + Adds an AWS::DocDB::DBInstance resource to the template. The AWS::DocDB::DBInstance Amazon DocumentDB (with MongoDB compatibility resource describes a DBInstance. For more information, see DBInstance: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html in the *Amazon DocumentDB Developer Guide*. .DESCRIPTION - Adds an AWS::DocDB::DBInstance resource to the template. + Adds an AWS::DocDB::DBInstance resource to the template. The AWS::DocDB::DBInstance Amazon DocumentDB (with MongoDB compatibility resource describes a DBInstance. For more information, see DBInstance: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html in the *Amazon DocumentDB Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html @@ -13,36 +13,63 @@ function New-VSDocDBDBInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBInstanceClass + The compute and memory capacity of the DB instance; for example, db.m4.large. If you change the class of an instance there can be some interruption in the cluster's service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass PrimitiveType: String UpdateType: Mutable .PARAMETER DBClusterIdentifier + The identifier of the DB cluster that the instance will belong to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZone + The Amazon EC2 Availability Zone that the DB instance is created in. +Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. +Example: us-east-1d +Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + The time range each week during which system maintenance can occur, in Universal Coordinated Time UTC. +Format: ddd:hh24:mi-ddd:hh24:mi +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. +Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun +Constraints: Minimum 30-minute window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade + Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. +Default: true + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DBInstanceIdentifier + The DB instance identifier. This parameter is stored as a lowercase string. +Constraints: ++ Must contain from 1 to 63 letters, numbers, or hyphens. ++ The first character must be a letter. ++ Cannot end with a hyphen or contain two consecutive hyphens. +Example: mydbinstance + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags to be assigned to the DB instance. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 index 361f6ae88..d617ea2c0 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSDocDBDBSubnetGroup { <# .SYNOPSIS - Adds an AWS::DocDB::DBSubnetGroup resource to the template. + Adds an AWS::DocDB::DBSubnetGroup resource to the template. The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBSubnetGroup. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see DBSubnetGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html in the *Amazon DocumentDB Developer Guide*. .DESCRIPTION - Adds an AWS::DocDB::DBSubnetGroup resource to the template. + Adds an AWS::DocDB::DBSubnetGroup resource to the template. The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBSubnetGroup. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see DBSubnetGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html in the *Amazon DocumentDB Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html @@ -13,22 +13,32 @@ function New-VSDocDBDBSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBSubnetGroupName + The name for the DB subnet group. This value is stored as a lowercase string. +Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. +Example: mySubnetgroup + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DBSubnetGroupDescription + The description for the DB subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds + The Amazon EC2 subnet IDs for the DB subnet group. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-subnetids UpdateType: Mutable .PARAMETER Tags + The tags to be assigned to the DB subnet group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 b/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 index 8b9f63773..f8c4475e2 100644 --- a/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 @@ -1,10 +1,14 @@ function New-VSDynamoDBTable { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table resource to the template. + Adds an AWS::DynamoDB::Table resource to the template. The AWS::DynamoDB::Table resource creates a DynamoDB table. For more information, see CreateTable: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html in the *Amazon DynamoDB API Reference*. .DESCRIPTION - Adds an AWS::DynamoDB::Table resource to the template. + Adds an AWS::DynamoDB::Table resource to the template. The AWS::DynamoDB::Table resource creates a DynamoDB table. For more information, see CreateTable: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html in the *Amazon DynamoDB API Reference*. + +You should be aware of the following behaviors when working with DynamoDB tables: + ++ AWS CloudFormation typically creates DynamoDB tables in parallel. However, if your template includes multiple DynamoDB tables with indexes, you must declare dependencies so that the tables are created sequentially. Amazon DynamoDB limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DynamoDB returns an error and the stack operation fails. For an example, see DynamoDB Table with a DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-examples-dependson. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html @@ -13,6 +17,9 @@ function New-VSDynamoDBTable { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AttributeDefinitions + A list of attributes that describe the key schema for the table and indexes. Duplicates are allowed. +Update requires: Some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. Replacement if you edit an existing AttributeDefinition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedef DuplicatesAllowed: True ItemType: AttributeDefinition @@ -20,11 +27,24 @@ function New-VSDynamoDBTable { UpdateType: Conditional .PARAMETER BillingMode + Specify how you are charged for read and write throughput and how you manage capacity. +Valid values include: ++ PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. ++ PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. +If not specified, the default is PROVISIONED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode PrimitiveType: String UpdateType: Mutable .PARAMETER GlobalSecondaryIndexes + Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. +If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable: https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html command. +If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. +Updates are not supported. The following are exceptions: ++ If you update only the provisioned throughput values of global secondary indexes, you can update the table without interruption. ++ You can delete or add one global secondary index without interruption. If you do both in the same update for example, by changing the index's logical ID, the update fails. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-gsi DuplicatesAllowed: True ItemType: GlobalSecondaryIndex @@ -32,6 +52,8 @@ function New-VSDynamoDBTable { UpdateType: Mutable .PARAMETER KeySchema + Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema DuplicatesAllowed: False ItemType: KeySchema @@ -39,6 +61,8 @@ function New-VSDynamoDBTable { UpdateType: Immutable .PARAMETER LocalSecondaryIndexes + Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-lsi DuplicatesAllowed: True ItemType: LocalSecondaryIndex @@ -46,31 +70,47 @@ function New-VSDynamoDBTable { UpdateType: Immutable .PARAMETER PointInTimeRecoverySpecification + The settings used to enable point in time recover. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification Type: PointInTimeRecoverySpecification UpdateType: Mutable .PARAMETER ProvisionedThroughput + Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html. +If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput Type: ProvisionedThroughput UpdateType: Mutable .PARAMETER SSESpecification + Specifies the settings to enable server-side encryption. +Update requires: Some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification Type: SSESpecification UpdateType: Conditional .PARAMETER StreamSpecification + The settings for the DynamoDB table stream, which capture changes to items stored in the table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification Type: StreamSpecification UpdateType: Mutable .PARAMETER TableName + A name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags DuplicatesAllowed: True ItemType: Tag @@ -78,6 +118,9 @@ function New-VSDynamoDBTable { UpdateType: Mutable .PARAMETER TimeToLiveSpecification + Specifies the Time to Live TTL settings for the table. +For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html in the Amazon DynamoDB Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification Type: TimeToLiveSpecification UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 index 6a962dc77..bfe75d5dd 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2CapacityReservation { <# .SYNOPSIS - Adds an AWS::EC2::CapacityReservation resource to the template. + Adds an AWS::EC2::CapacityReservation resource to the template. Creates a new Capacity Reservation with the specified attributes. For more information, see Capacity Reservations: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html in the *Amazon Elastic Compute Cloud User Guide*. .DESCRIPTION - Adds an AWS::EC2::CapacityReservation resource to the template. + Adds an AWS::EC2::CapacityReservation resource to the template. Creates a new Capacity Reservation with the specified attributes. For more information, see Capacity Reservations: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html in the *Amazon Elastic Compute Cloud User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html @@ -13,57 +13,88 @@ function New-VSEC2CapacityReservation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tenancy + Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: ++ default - The Capacity Reservation is created on hardware that is shared with other AWS accounts. ++ dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tenancy PrimitiveType: String UpdateType: Immutable .PARAMETER EndDateType + Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: ++ unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited. ++ limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddatetype PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceCount + The number of instances for which to reserve capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER TagSpecifications + The tags to apply to the Capacity Reservation during launch. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tagspecifications ItemType: TagSpecification UpdateType: Immutable .PARAMETER AvailabilityZone + The Availability Zone in which to create the Capacity Reservation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER InstancePlatform + The type of operating system for which to reserve capacity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instanceplatform PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceType + The instance type for which to reserve capacity. For more information, see Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER EphemeralStorage + Indicates whether the Capacity Reservation supports instances with temporary, block-level storage. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ephemeralstorage PrimitiveType: Boolean UpdateType: Immutable .PARAMETER InstanceMatchCriteria + Indicates the type of instance launches that the Capacity Reservation accepts. The options include: ++ open - The Capacity Reservation automatically matches all instances that have matching attributes instance type, platform, and Availability Zone. Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. ++ targeted - The Capacity Reservation only accepts instances that have matching attributes instance type, platform, and Availability Zone, and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. +Default: open + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancematchcriteria PrimitiveType: String UpdateType: Immutable .PARAMETER EndDate + The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. +You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited. +If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddate PrimitiveType: String UpdateType: Mutable .PARAMETER EbsOptimized + Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ebsoptimized PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 index b175c853d..311a68e9e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 @@ -1,10 +1,10 @@ function New-VSEC2ClientVpnAuthorizationRule { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnAuthorizationRule resource to the template. + Adds an AWS::EC2::ClientVpnAuthorizationRule resource to the template. Specifies an ingress authorization rule to add to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks. .DESCRIPTION - Adds an AWS::EC2::ClientVpnAuthorizationRule resource to the template. + Adds an AWS::EC2::ClientVpnAuthorizationRule resource to the template. Specifies an ingress authorization rule to add to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html @@ -13,26 +13,36 @@ function New-VSEC2ClientVpnAuthorizationRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientVpnEndpointId + The ID of the Client VPN endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-clientvpnendpointid PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A brief description of the authorization rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-description PrimitiveType: String UpdateType: Immutable .PARAMETER AccessGroupId + The ID of the Active Directory group to grant access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-accessgroupid PrimitiveType: String UpdateType: Immutable .PARAMETER TargetNetworkCidr + The IPv4 address range, in CIDR notation, of the network for which access is being authorized. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-targetnetworkcidr PrimitiveType: String UpdateType: Immutable .PARAMETER AuthorizeAllGroups + Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 index feaab77ad..68a245d57 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 @@ -1,10 +1,10 @@ function New-VSEC2ClientVpnEndpoint { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnEndpoint resource to the template. + Adds an AWS::EC2::ClientVpnEndpoint resource to the template. Specifies a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. .DESCRIPTION - Adds an AWS::EC2::ClientVpnEndpoint resource to the template. + Adds an AWS::EC2::ClientVpnEndpoint resource to the template. Specifies a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html @@ -13,54 +13,80 @@ function New-VSEC2ClientVpnEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientCidrBlock + The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER ConnectionLogOptions + Information about the client connection logging options. +If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: ++ Client connection requests ++ Client connection results successful and unsuccessful ++ Reasons for unsuccessful client connection requests ++ Client connection termination time + Type: ConnectionLogOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions UpdateType: Mutable .PARAMETER SplitTunnel + + Client VPN Endpoints: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html in the *AWS Client VPN Administrator Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Description + A brief description of the Client VPN endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description PrimitiveType: String UpdateType: Mutable .PARAMETER TagSpecifications + The tags to apply to the Client VPN endpoint during creation. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications ItemType: TagSpecification UpdateType: Immutable .PARAMETER AuthenticationOptions + Information about the authentication method to be used to authenticate clients. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions ItemType: ClientAuthenticationRequest UpdateType: Immutable .PARAMETER ServerCertificateArn + The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide: https://docs.aws.amazon.com/acm/latest/userguide/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn PrimitiveType: String UpdateType: Mutable .PARAMETER DnsServers + Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers UpdateType: Mutable .PARAMETER TransportProtocol + The transport protocol to be used by the VPN session. +Default value: udp + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol PrimitiveType: String UpdateType: Immutable .PARAMETER VpnPort + + Client VPN Endpoints: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html in the *AWS Client VPN Administrator Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 index 6b67ef056..93cc80358 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 @@ -1,10 +1,10 @@ function New-VSEC2ClientVpnRoute { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnRoute resource to the template. + Adds an AWS::EC2::ClientVpnRoute resource to the template. Specifies a network route to add to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. .DESCRIPTION - Adds an AWS::EC2::ClientVpnRoute resource to the template. + Adds an AWS::EC2::ClientVpnRoute resource to the template. Specifies a network route to add to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html @@ -13,21 +13,33 @@ function New-VSEC2ClientVpnRoute { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientVpnEndpointId + The ID of the Client VPN endpoint to which to add the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-clientvpnendpointid PrimitiveType: String UpdateType: Immutable .PARAMETER TargetVpcSubnetId + The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-targetvpcsubnetid PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A brief description of the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-description PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationCidrBlock + The IPv4 address range, in CIDR notation, of the route destination. For example: ++ To add a route for Internet access, enter 0.0.0.0/0 ++ To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range ++ To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range +Route address ranges cannot overlap with the CIDR range specified for client allocation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-destinationcidrblock PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 index 5a9efa909..a55572208 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2ClientVpnTargetNetworkAssociation { <# .SYNOPSIS - Adds an AWS::EC2::ClientVpnTargetNetworkAssociation resource to the template. + Adds an AWS::EC2::ClientVpnTargetNetworkAssociation resource to the template. Specifies a target network to associate with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. .DESCRIPTION - Adds an AWS::EC2::ClientVpnTargetNetworkAssociation resource to the template. + Adds an AWS::EC2::ClientVpnTargetNetworkAssociation resource to the template. Specifies a target network to associate with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html @@ -13,11 +13,15 @@ function New-VSEC2ClientVpnTargetNetworkAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientVpnEndpointId + The ID of the Client VPN endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-clientvpnendpointid PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetId + The ID of the subnet to associate with the Client VPN endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-subnetid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 index 0c73b52da..0988aada1 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 @@ -1,10 +1,10 @@ function New-VSEC2CustomerGateway { <# .SYNOPSIS - Adds an AWS::EC2::CustomerGateway resource to the template. + Adds an AWS::EC2::CustomerGateway resource to the template. Specifies a customer gateway. .DESCRIPTION - Adds an AWS::EC2::CustomerGateway resource to the template. + Adds an AWS::EC2::CustomerGateway resource to the template. Specifies a customer gateway. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html @@ -13,16 +13,23 @@ function New-VSEC2CustomerGateway { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BgpAsn + For devices that support BGP, the customer gateway's BGP ASN. +Default: 65000 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-bgpasn PrimitiveType: Integer UpdateType: Immutable .PARAMETER IpAddress + The Internet-routable IP address for the customer gateway's outside interface. The address must be static. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-ipaddress PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + One or more tags for the customer gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-tags DuplicatesAllowed: True ItemType: Tag @@ -30,6 +37,8 @@ function New-VSEC2CustomerGateway { UpdateType: Mutable .PARAMETER Type + The type of VPN connection that this customer gateway supports ipsec.1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 b/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 index 16bb620c4..fe15fe308 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 @@ -1,10 +1,12 @@ function New-VSEC2DHCPOptions { <# .SYNOPSIS - Adds an AWS::EC2::DHCPOptions resource to the template. + Adds an AWS::EC2::DHCPOptions resource to the template. Specifies a set of DHCP options for your VPC. .DESCRIPTION - Adds an AWS::EC2::DHCPOptions resource to the template. + Adds an AWS::EC2::DHCPOptions resource to the template. Specifies a set of DHCP options for your VPC. + +You must specify at least one of the following properties: DomainNameServers, NetbiosNameServers, NtpServers. If you specify NetbiosNameServers, you must specify NetbiosNodeType. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html @@ -13,11 +15,15 @@ function New-VSEC2DHCPOptions { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DomainName + This value is used to complete unqualified DNS hostnames. If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify *region*.compute.internal for example, ap-northeast-1.compute.internal. Otherwise, specify a domain name for example, *MyCompany.com*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER DomainNameServers + The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance to receive a custom DNS hostname as specified in DomainName, you must set this to a custom DNS server. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-domainnameservers DuplicatesAllowed: False PrimitiveItemType: String @@ -25,6 +31,8 @@ function New-VSEC2DHCPOptions { UpdateType: Immutable .PARAMETER NetbiosNameServers + The IPv4 addresses of up to four NetBIOS name servers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-netbiosnameservers DuplicatesAllowed: False PrimitiveItemType: String @@ -32,11 +40,15 @@ function New-VSEC2DHCPOptions { UpdateType: Immutable .PARAMETER NetbiosNodeType + The NetBIOS node type 1, 2, 4, or 8. We recommend that you specify 2 broadcast and multicast are not currently supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-netbiosnodetype PrimitiveType: Integer UpdateType: Immutable .PARAMETER NtpServers + The IPv4 addresses of up to four Network Time Protocol NTP servers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-ntpservers DuplicatesAllowed: True PrimitiveItemType: String @@ -44,6 +56,8 @@ function New-VSEC2DHCPOptions { UpdateType: Immutable .PARAMETER Tags + Any tags assigned to the DHCP options set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 index 5d6c6b903..eddcea8ef 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 @@ -1,10 +1,10 @@ function New-VSEC2EC2Fleet { <# .SYNOPSIS - Adds an AWS::EC2::EC2Fleet resource to the template. + Adds an AWS::EC2::EC2Fleet resource to the template. Specifies the configuration information to launch a fleet—or group—of instances. An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see Launching an EC2 Fleet: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html in the *Amazon EC2 User Guide for Linux Instances*. .DESCRIPTION - Adds an AWS::EC2::EC2Fleet resource to the template. + Adds an AWS::EC2::EC2Fleet resource to the template. Specifies the configuration information to launch a fleet—or group—of instances. An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see Launching an EC2 Fleet: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html in the *Amazon EC2 User Guide for Linux Instances*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html @@ -13,58 +13,80 @@ function New-VSEC2EC2Fleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TargetCapacitySpecification + The TotalTargetCapacity, OnDemandTargetCapacity, SpotTargetCapacity, and DefaultCapacityType structure. + Type: TargetCapacitySpecificationRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-targetcapacityspecification UpdateType: Mutable .PARAMETER OnDemandOptions + The allocation strategy of On-Demand Instances in an EC2 Fleet. + Type: OnDemandOptionsRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-ondemandoptions UpdateType: Immutable .PARAMETER Type + The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances maintain. A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-configuration-strategies.html#ec2-fleet-request-type in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-type PrimitiveType: String UpdateType: Immutable .PARAMETER ExcessCapacityTerminationPolicy + Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-excesscapacityterminationpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER TagSpecifications + The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template. For information about tagging after launch, see Tagging Your Resources: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-tagspecifications ItemType: TagSpecification UpdateType: Immutable .PARAMETER SpotOptions + Describes the configuration of Spot Instances in an EC2 Fleet. + Type: SpotOptionsRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-spotoptions UpdateType: Immutable .PARAMETER ValidFrom + The start date and time of the request, in UTC format for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z. The default is to start fulfilling the request immediately. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validfrom PrimitiveType: String UpdateType: Immutable .PARAMETER ReplaceUnhealthyInstances + Indicates whether EC2 Fleet should replace unhealthy instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-replaceunhealthyinstances PrimitiveType: Boolean UpdateType: Immutable .PARAMETER LaunchTemplateConfigs + The configuration for the EC2 Fleet. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-launchtemplateconfigs ItemType: FleetLaunchTemplateConfigRequest UpdateType: Immutable .PARAMETER TerminateInstancesWithExpiration + Indicates whether running instances should be terminated when the EC2 Fleet expires. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-terminateinstanceswithexpiration PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ValidUntil + The end date and time of the request, in UTC format for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z. At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validuntil PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 index c6a1b86a0..e364322e5 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 @@ -1,10 +1,18 @@ function New-VSEC2EIP { <# .SYNOPSIS - Adds an AWS::EC2::EIP resource to the template. + Adds an AWS::EC2::EIP resource to the template. Specifies an Elastic IP (EIP address and can, optionally, associate it with an Amazon EC2 instance. .DESCRIPTION - Adds an AWS::EC2::EIP resource to the template. + Adds an AWS::EC2::EIP resource to the template. Specifies an Elastic IP (EIP address and can, optionally, associate it with an Amazon EC2 instance. + +You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP. For more information, see Bring Your Own IP Addresses (BYOIP: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html in the *Amazon Elastic Compute Cloud User Guide*. + +EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation. + +An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region. + +For more information, see Elastic IP Addresses: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html in the *Amazon Elastic Compute Cloud User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html @@ -13,16 +21,25 @@ function New-VSEC2EIP { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Domain + Set to vpc to allocate the address for use with instances in a VPC. +Default: The address is for use with instances in EC2-Classic. +If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html on this resource. +Required when allocating an address to a VPC + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-domain PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceId + The ID of the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid PrimitiveType: String UpdateType: Conditional .PARAMETER PublicIpv4Pool + The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-publicipv4pool PrimitiveType: String UpdateType: Conditional diff --git a/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 index c8eaba3b5..d65682723 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 @@ -1,10 +1,16 @@ function New-VSEC2EIPAssociation { <# .SYNOPSIS - Adds an AWS::EC2::EIPAssociation resource to the template. + Adds an AWS::EC2::EIPAssociation resource to the template. Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. .DESCRIPTION - Adds an AWS::EC2::EIPAssociation resource to the template. + Adds an AWS::EC2::EIPAssociation resource to the template. Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. + +An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html in the *Amazon Elastic Compute Cloud User Guide*. + +EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. + +VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html @@ -13,26 +19,37 @@ function New-VSEC2EIPAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AllocationId + EC2-VPC] The allocation ID. This is required for EC2-VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-allocationid PrimitiveType: String UpdateType: Conditional .PARAMETER EIP + The Elastic IP address to associate with the instance. This is required for EC2-Classic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-eip PrimitiveType: String UpdateType: Conditional .PARAMETER InstanceId + The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-instanceid PrimitiveType: String UpdateType: Conditional .PARAMETER NetworkInterfaceId + EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. +For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-networkinterfaceid PrimitiveType: String UpdateType: Conditional .PARAMETER PrivateIpAddress + EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-PrivateIpAddress PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 index 85348c45d..ca7309312 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 @@ -1,10 +1,10 @@ function New-VSEC2EgressOnlyInternetGateway { <# .SYNOPSIS - Adds an AWS::EC2::EgressOnlyInternetGateway resource to the template. + Adds an AWS::EC2::EgressOnlyInternetGateway resource to the template. IPv6 only] Specifies an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. .DESCRIPTION - Adds an AWS::EC2::EgressOnlyInternetGateway resource to the template. + Adds an AWS::EC2::EgressOnlyInternetGateway resource to the template. IPv6 only] Specifies an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html @@ -13,6 +13,8 @@ function New-VSEC2EgressOnlyInternetGateway { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER VpcId + The ID of the VPC for which to create the egress-only internet gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 b/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 index 32b5c8523..0fe6ba58f 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 @@ -1,10 +1,10 @@ function New-VSEC2FlowLog { <# .SYNOPSIS - Adds an AWS::EC2::FlowLog resource to the template. + Adds an AWS::EC2::FlowLog resource to the template. Specifies an Amazon Elastic Compute Cloud (Amazon EC2 flow log that captures IP traffic for a specified network interface, subnet, or VPC. To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn't reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see VPC Flow Logs: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html in the *Amazon VPC User Guide*. .DESCRIPTION - Adds an AWS::EC2::FlowLog resource to the template. + Adds an AWS::EC2::FlowLog resource to the template. Specifies an Amazon Elastic Compute Cloud (Amazon EC2 flow log that captures IP traffic for a specified network interface, subnet, or VPC. To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn't reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see VPC Flow Logs: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html in the *Amazon VPC User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html @@ -13,36 +13,57 @@ function New-VSEC2FlowLog { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeliverLogsPermissionArn + The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. +If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn PrimitiveType: String UpdateType: Immutable .PARAMETER LogDestination + Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType. +If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name ARN of the CloudWatch Logs log group. +If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination PrimitiveType: String UpdateType: Immutable .PARAMETER LogDestinationType + Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3. +If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. +Default: cloud-watch-logs + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype PrimitiveType: String UpdateType: Immutable .PARAMETER LogGroupName + The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. +If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceId + The ID of the subnet, network interface, or VPC for which you want to create a flow log. +Constraints: Maximum of 1000 resources + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceType + The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype PrimitiveType: String UpdateType: Immutable .PARAMETER TrafficType + The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 index dbbf3cfa2..e85a55ca2 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 @@ -1,10 +1,10 @@ function New-VSEC2Host { <# .SYNOPSIS - Adds an AWS::EC2::Host resource to the template. + Adds an AWS::EC2::Host resource to the template. Allocates a fully dedicated physical server for launching EC2 instances. Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see Dedicated Hosts: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html in the *Amazon EC2 User Guide for Linux Instances*. .DESCRIPTION - Adds an AWS::EC2::Host resource to the template. + Adds an AWS::EC2::Host resource to the template. Allocates a fully dedicated physical server for launching EC2 instances. Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see Dedicated Hosts: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html in the *Amazon EC2 User Guide for Linux Instances*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html @@ -13,21 +13,31 @@ function New-VSEC2Host { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoPlacement + Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding in the *Amazon EC2 User Guide for Linux Instances*. +Default: on + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement PrimitiveType: String UpdateType: Mutable .PARAMETER AvailabilityZone + The Availability Zone in which to allocate the Dedicated Host. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER HostRecovery + Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html in the *Amazon Elastic Compute Cloud User Guide*. +Default: off + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostrecovery PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 index 361e1957e..985bc32cf 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 @@ -1,10 +1,12 @@ function New-VSEC2Instance { <# .SYNOPSIS - Adds an AWS::EC2::Instance resource to the template. + Adds an AWS::EC2::Instance resource to the template. Specifies an EC2 instance. .DESCRIPTION - Adds an AWS::EC2::Instance resource to the template. + Adds an AWS::EC2::Instance resource to the template. Specifies an EC2 instance. + +If an Elastic IP address is attached to your instance, AWS CloudFormation reattaches the Elastic IP address after it updates the instance. For more information about updating stacks, see AWS CloudFormation Stacks Updates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html @@ -13,21 +15,31 @@ function New-VSEC2Instance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AdditionalInfo + Reserved. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-additionalinfo PrimitiveType: String UpdateType: Conditional .PARAMETER Affinity + Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on on a best-effort basis, specify default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-affinity PrimitiveType: String UpdateType: Conditional .PARAMETER AvailabilityZone + The Availability Zone of the instance. +If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER BlockDeviceMappings + The block device mapping entries that defines the block devices to attach to the instance at launch. +By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can only override the volume size, volume type, and DeleteOnTermination setting. After the instance is running, you can only modify the DeleteOnTermination settings of the attached EBS volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-blockdevicemappings DuplicatesAllowed: True ItemType: BlockDeviceMapping @@ -35,26 +47,39 @@ function New-VSEC2Instance { UpdateType: Conditional .PARAMETER CpuOptions + The CPU options for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-cpuoptions Type: CpuOptions UpdateType: Immutable .PARAMETER CreditSpecification + The credit option for CPU usage of the T2 or T3 instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html. For more information, see Burstable Performance Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html in the *Amazon Elastic Compute Cloud User Guide*. +Default: standard T2 instances or unlimited T3 instances + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-creditspecification Type: CreditSpecification UpdateType: Mutable .PARAMETER DisableApiTermination + If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-disableapitermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EbsOptimized + Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ebsoptimized PrimitiveType: Boolean UpdateType: Conditional .PARAMETER ElasticGpuSpecifications + An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications DuplicatesAllowed: False ItemType: ElasticGpuSpecification @@ -62,6 +87,8 @@ function New-VSEC2Instance { UpdateType: Immutable .PARAMETER ElasticInferenceAccelerators + An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning DL inference workloads. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticinferenceaccelerators DuplicatesAllowed: False ItemType: ElasticInferenceAccelerator @@ -69,46 +96,68 @@ function New-VSEC2Instance { UpdateType: Immutable .PARAMETER HibernationOptions + + EBS-Optimized Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#EBSOptimized in the *Amazon EC2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hibernationoptions Type: HibernationOptions UpdateType: Immutable .PARAMETER HostId + If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostid PrimitiveType: String UpdateType: Conditional .PARAMETER HostResourceGroupArn + + EBS-Optimized Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#EBSOptimized in the *Amazon EC2 API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn PrimitiveType: String UpdateType: Immutable .PARAMETER IamInstanceProfile + The IAM instance profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile PrimitiveType: String UpdateType: Mutable .PARAMETER ImageId + The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-imageid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceInitiatedShutdownBehavior + Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system command for system shutdown. +Default: stop + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceType + The instance type. For more information, see Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html in the *Amazon Elastic Compute Cloud User Guide*. +Default: m1.small + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instancetype PrimitiveType: String UpdateType: Conditional .PARAMETER Ipv6AddressCount + EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. +You cannot specify this option and the network interfaces option in the same request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresscount PrimitiveType: Integer UpdateType: Immutable .PARAMETER Ipv6Addresses + EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. +You cannot specify this option and the network interfaces option in the same request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresses DuplicatesAllowed: True ItemType: InstanceIpv6Address @@ -116,21 +165,31 @@ function New-VSEC2Instance { UpdateType: Immutable .PARAMETER KernelId + The ID of the kernel. +We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-kernelid PrimitiveType: String UpdateType: Conditional .PARAMETER KeyName + The name of the key pair. You can create a key pair using CreateKeyPair: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html or ImportKeyPair: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html. +If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-keyname PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchTemplate + The launch template to use to launch the instances. Any parameters that you specify in the AWS CloudFormation template override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-launchtemplate Type: LaunchTemplateSpecification UpdateType: Immutable .PARAMETER LicenseSpecifications + The license configurations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-licensespecifications DuplicatesAllowed: False ItemType: LicenseSpecification @@ -138,11 +197,17 @@ function New-VSEC2Instance { UpdateType: Immutable .PARAMETER Monitoring + Specifies whether detailed monitoring is enabled for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-monitoring PrimitiveType: Boolean UpdateType: Mutable .PARAMETER NetworkInterfaces + The network interfaces to associate with the instance. +If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed. +If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html to declare a dependency on the VPC-gateway attachment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-networkinterfaces DuplicatesAllowed: True ItemType: NetworkInterface @@ -150,21 +215,34 @@ function New-VSEC2Instance { UpdateType: Immutable .PARAMETER PlacementGroupName + The name of an existing placement group that you want to launch the instance into for cluster instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-placementgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER PrivateIpAddress + EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. +Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request. +You cannot specify this option and the network interfaces option in the same request. +If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance in order to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privateipaddress PrimitiveType: String UpdateType: Immutable .PARAMETER RamdiskId + The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID. +We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html in the *Amazon Elastic Compute Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ramdiskid PrimitiveType: String UpdateType: Conditional .PARAMETER SecurityGroupIds + The IDs of the security groups. You can create a security group using CreateSecurityGroup: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html. +If you specify a network interface, you must specify any security groups as part of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroupids DuplicatesAllowed: True PrimitiveItemType: String @@ -172,6 +250,10 @@ function New-VSEC2Instance { UpdateType: Conditional .PARAMETER SecurityGroups + EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead. +You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template. +Default: Amazon EC2 uses the default security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroups DuplicatesAllowed: True PrimitiveItemType: String @@ -179,11 +261,16 @@ function New-VSEC2Instance { UpdateType: Immutable .PARAMETER SourceDestCheck + Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html in the *Amazon Virtual Private Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-sourcedestcheck PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SsmAssociations + The SSM document: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see Create an Instance Profile for Systems Manager: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html in the *AWS Systems Manager User Guide*. +You can currently associate only one document with an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ssmassociations DuplicatesAllowed: True ItemType: SsmAssociation @@ -191,11 +278,16 @@ function New-VSEC2Instance { UpdateType: Mutable .PARAMETER SubnetId + EC2-VPC] The ID of the subnet to launch the instance into. +If you specify a network interface, you must specify any subnets as part of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tags DuplicatesAllowed: True ItemType: Tag @@ -203,16 +295,22 @@ function New-VSEC2Instance { UpdateType: Mutable .PARAMETER Tenancy + The tenancy of the instance if the instance is running in a VPC. An instance with a tenancy of dedicated runs on single-tenant hardware. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tenancy PrimitiveType: String UpdateType: Conditional .PARAMETER UserData + The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html Linux and Adding User Data: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data Windows. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-userdata PrimitiveType: String UpdateType: Conditional .PARAMETER Volumes + The volumes to attach to the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-volumes DuplicatesAllowed: True ItemType: Volume diff --git a/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 index 905108154..f9dd548c2 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 @@ -1,10 +1,10 @@ function New-VSEC2InternetGateway { <# .SYNOPSIS - Adds an AWS::EC2::InternetGateway resource to the template. + Adds an AWS::EC2::InternetGateway resource to the template. Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC. .DESCRIPTION - Adds an AWS::EC2::InternetGateway resource to the template. + Adds an AWS::EC2::InternetGateway resource to the template. Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html @@ -13,6 +13,8 @@ function New-VSEC2InternetGateway { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + Any tags to assign to the internet gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 index 55a2321b0..1289c7e75 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSEC2LaunchTemplate { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate resource to the template. + Adds an AWS::EC2::LaunchTemplate resource to the template. Specifies a launch template for an Amazon EC2 instance. A launch template contains the parameters to launch an instance. .DESCRIPTION - Adds an AWS::EC2::LaunchTemplate resource to the template. + Adds an AWS::EC2::LaunchTemplate resource to the template. Specifies a launch template for an Amazon EC2 instance. A launch template contains the parameters to launch an instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html @@ -13,11 +13,15 @@ function New-VSEC2LaunchTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LaunchTemplateName + A name for the launch template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchTemplateData + The information for the launch template. + Type: LaunchTemplateData Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 index bf76673ac..b1aa89bb4 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 @@ -1,10 +1,12 @@ function New-VSEC2NatGateway { <# .SYNOPSIS - Adds an AWS::EC2::NatGateway resource to the template. + Adds an AWS::EC2::NatGateway resource to the template. Specifies a network address translation (NAT gateway in the specified public subnet. Use a NAT gateway to allow instances in a private subnet to connect to the Internet or to other AWS services, but prevent the Internet from initiating a connection with those instances. For more information and a sample architectural diagram, see NAT Gateways: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html in the *Amazon VPC User Guide*. .DESCRIPTION - Adds an AWS::EC2::NatGateway resource to the template. + Adds an AWS::EC2::NatGateway resource to the template. Specifies a network address translation (NAT gateway in the specified public subnet. Use a NAT gateway to allow instances in a private subnet to connect to the Internet or to other AWS services, but prevent the Internet from initiating a connection with those instances. For more information and a sample architectural diagram, see NAT Gateways: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html in the *Amazon VPC User Guide*. + +If you add a default route (AWS::EC2::Route resource that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html @@ -13,16 +15,22 @@ function New-VSEC2NatGateway { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AllocationId + The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetId + The public subnet in which to create the NAT gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags key–value pairs to associate with this resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 index acaff787e..916b4c247 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 @@ -1,10 +1,10 @@ function New-VSEC2NetworkAcl { <# .SYNOPSIS - Adds an AWS::EC2::NetworkAcl resource to the template. + Adds an AWS::EC2::NetworkAcl resource to the template. Specifies a network ACL for your VPC. .DESCRIPTION - Adds an AWS::EC2::NetworkAcl resource to the template. + Adds an AWS::EC2::NetworkAcl resource to the template. Specifies a network ACL for your VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html @@ -13,6 +13,8 @@ function New-VSEC2NetworkAcl { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + An arbitrary set of tags key–value pairs for this ACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html#cfn-ec2-networkacl-tags DuplicatesAllowed: True ItemType: Tag @@ -20,6 +22,8 @@ function New-VSEC2NetworkAcl { UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC for the network ACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html#cfn-ec2-networkacl-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 index daeaaf10f..e8447cd6f 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 @@ -1,10 +1,10 @@ function New-VSEC2NetworkAclEntry { <# .SYNOPSIS - Adds an AWS::EC2::NetworkAclEntry resource to the template. + Adds an AWS::EC2::NetworkAclEntry resource to the template. Specifies an entry, known as a rule, in a network ACL with a rule number you specify. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. .DESCRIPTION - Adds an AWS::EC2::NetworkAclEntry resource to the template. + Adds an AWS::EC2::NetworkAclEntry resource to the template. Specifies an entry, known as a rule, in a network ACL with a rule number you specify. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html @@ -13,46 +13,65 @@ function New-VSEC2NetworkAclEntry { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CidrBlock + The IPv4 CIDR range to allow or deny, in CIDR notation for example, 172.16.0.0/24. Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-cidrblock PrimitiveType: String UpdateType: Mutable .PARAMETER Egress + Whether this rule applies to egress traffic from the subnet true or ingress traffic to the subnet false. By default, AWS CloudFormation specifies false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-egress PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Icmp + The Internet Control Message Protocol ICMP code and type. Requirement is conditional: Required if specifying 1 ICMP for the protocol parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-icmp Type: Icmp UpdateType: Mutable .PARAMETER Ipv6CidrBlock + The IPv6 network range to allow or deny, in CIDR notation. Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-ipv6cidrblock PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkAclId + The ID of the ACL for the entry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-networkaclid PrimitiveType: String UpdateType: Immutable .PARAMETER PortRange + The range of port numbers for the UDP/TCP protocol. Conditional required if specifying 6 TCP or 17 UDP for the protocol parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-portrange Type: PortRange UpdateType: Mutable .PARAMETER Protocol + The IP protocol that the rule applies to. You must specify -1 or a protocol number. You can specify -1 for all protocols. +If you specify -1, all ports are opened and the PortRange property is ignored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-protocol PrimitiveType: Integer UpdateType: Mutable .PARAMETER RuleAction + Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-ruleaction PrimitiveType: String UpdateType: Mutable .PARAMETER RuleNumber + Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-rulenumber PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 index 6de0634a4..991cc3c3f 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 @@ -1,10 +1,10 @@ function New-VSEC2NetworkInterface { <# .SYNOPSIS - Adds an AWS::EC2::NetworkInterface resource to the template. + Adds an AWS::EC2::NetworkInterface resource to the template. Describes a network interface in an Elastic Compute Cloud (EC2 instance for AWS CloudFormation. .DESCRIPTION - Adds an AWS::EC2::NetworkInterface resource to the template. + Adds an AWS::EC2::NetworkInterface resource to the template. Describes a network interface in an Elastic Compute Cloud (EC2 instance for AWS CloudFormation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html @@ -13,11 +13,15 @@ function New-VSEC2NetworkInterface { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-description PrimitiveType: String UpdateType: Mutable .PARAMETER GroupSet + A list of security group IDs associated with this network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-groupset DuplicatesAllowed: False PrimitiveItemType: String @@ -25,26 +29,36 @@ function New-VSEC2NetworkInterface { UpdateType: Mutable .PARAMETER InterfaceType + The type of network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-interfacetype PrimitiveType: String UpdateType: Immutable .PARAMETER Ipv6AddressCount + The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-ipv6addresscount PrimitiveType: Integer UpdateType: Mutable .PARAMETER Ipv6Addresses + One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-ipv6addresses Type: InstanceIpv6Address UpdateType: Mutable .PARAMETER PrivateIpAddress + Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-privateipaddress PrimitiveType: String UpdateType: Immutable .PARAMETER PrivateIpAddresses + Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-privateipaddresses DuplicatesAllowed: False ItemType: PrivateIpAddressSpecification @@ -52,21 +66,30 @@ function New-VSEC2NetworkInterface { UpdateType: Conditional .PARAMETER SecondaryPrivateIpAddressCount + The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses. +The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI in the *Amazon Virtual Private Cloud User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-secondaryprivateipcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER SourceDestCheck + Indicates whether traffic to or from the instance is validated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-sourcedestcheck PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet to associate with the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + An arbitrary set of tags key–value pairs for this network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 index ba84689da..54b46098d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 @@ -1,10 +1,10 @@ function New-VSEC2NetworkInterfaceAttachment { <# .SYNOPSIS - Adds an AWS::EC2::NetworkInterfaceAttachment resource to the template. + Adds an AWS::EC2::NetworkInterfaceAttachment resource to the template. Attaches an elastic network interface (ENI to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption. .DESCRIPTION - Adds an AWS::EC2::NetworkInterfaceAttachment resource to the template. + Adds an AWS::EC2::NetworkInterfaceAttachment resource to the template. Attaches an elastic network interface (ENI to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html @@ -13,21 +13,29 @@ function New-VSEC2NetworkInterfaceAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeleteOnTermination + Whether to delete the network interface when the instance terminates. By default, this value is set to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deleteonterm PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DeviceIndex + The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deviceindex PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceId + The ID of the instance to which you will attach the ENI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-instanceid PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkInterfaceId + The ID of the ENI that you want to attach. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-networkinterfaceid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 index 3ba2736bf..ee7694c55 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 @@ -1,10 +1,10 @@ function New-VSEC2NetworkInterfacePermission { <# .SYNOPSIS - Adds an AWS::EC2::NetworkInterfacePermission resource to the template. + Adds an AWS::EC2::NetworkInterfacePermission resource to the template. Specifies a permission for an Amazon EC2 network interface. For example, you can grant an AWS authorized partner account permission to attach the specified network interface to an instance in their account. .DESCRIPTION - Adds an AWS::EC2::NetworkInterfacePermission resource to the template. + Adds an AWS::EC2::NetworkInterfacePermission resource to the template. Specifies a permission for an Amazon EC2 network interface. For example, you can grant an AWS authorized partner account permission to attach the specified network interface to an instance in their account. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html @@ -13,16 +13,22 @@ function New-VSEC2NetworkInterfacePermission { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AwsAccountId + The AWS account ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid PrimitiveType: String UpdateType: Immutable .PARAMETER NetworkInterfaceId + The ID of the network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid PrimitiveType: String UpdateType: Immutable .PARAMETER Permission + The type of permission to grant: INSTANCE-ATTACH or EIP-ASSOCIATE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 b/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 index 080f986ea..4feabad19 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 @@ -1,10 +1,14 @@ function New-VSEC2PlacementGroup { <# .SYNOPSIS - Adds an AWS::EC2::PlacementGroup resource to the template. + Adds an AWS::EC2::PlacementGroup resource to the template. Specifies a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. .DESCRIPTION - Adds an AWS::EC2::PlacementGroup resource to the template. + Adds an AWS::EC2::PlacementGroup resource to the template. Specifies a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. + +A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. + +For more information, see Placement Groups: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html in the *Amazon Elastic Compute Cloud User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html @@ -13,6 +17,8 @@ function New-VSEC2PlacementGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Strategy + The placement strategy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-strategy PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 index 8725dce36..e22844bf1 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 @@ -1,10 +1,12 @@ function New-VSEC2Route { <# .SYNOPSIS - Adds an AWS::EC2::Route resource to the template. + Adds an AWS::EC2::Route resource to the template. Specifies a route in a route table within a VPC. .DESCRIPTION - Adds an AWS::EC2::Route resource to the template. + Adds an AWS::EC2::Route resource to the template. Specifies a route in a route table within a VPC. + +You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html @@ -13,51 +15,77 @@ function New-VSEC2Route { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DestinationCidrBlock + The IPv4 CIDR block used for the destination match. +You must specify the DestinationCidrBlock or DestinationIpv6CidrBlock property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationIpv6CidrBlock + The IPv6 CIDR block used for the destination match. +You must specify the DestinationCidrBlock or DestinationIpv6CidrBlock property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock PrimitiveType: String UpdateType: Mutable .PARAMETER EgressOnlyInternetGatewayId + The ID of the egress-only internet gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid PrimitiveType: String UpdateType: Mutable .PARAMETER GatewayId + The ID of a gateway attached to your VPC. +You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceId + The ID of a NAT instance in your VPC. +You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid PrimitiveType: String UpdateType: Mutable .PARAMETER NatGatewayId + The ID of a NAT gateway. +You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkInterfaceId + The ID of the network interface. +You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid PrimitiveType: String UpdateType: Mutable .PARAMETER RouteTableId + The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid PrimitiveType: String UpdateType: Immutable .PARAMETER TransitGatewayId + The ID of a transit gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid PrimitiveType: String UpdateType: Mutable .PARAMETER VpcPeeringConnectionId + The ID of a VPC peering connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 b/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 index 21d1ee474..ec26884f0 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 @@ -1,10 +1,12 @@ function New-VSEC2RouteTable { <# .SYNOPSIS - Adds an AWS::EC2::RouteTable resource to the template. + Adds an AWS::EC2::RouteTable resource to the template. Specifies a route table for a specified VPC. After you create a route table, you can add routes and associate the table with a subnet. .DESCRIPTION - Adds an AWS::EC2::RouteTable resource to the template. + Adds an AWS::EC2::RouteTable resource to the template. Specifies a route table for a specified VPC. After you create a route table, you can add routes and associate the table with a subnet. + +For more information, see Route Tables: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html in the *Amazon Virtual Private Cloud User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html @@ -13,6 +15,8 @@ function New-VSEC2RouteTable { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + Any tags assigned to the route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html#cfn-ec2-routetable-tags DuplicatesAllowed: True ItemType: Tag @@ -20,6 +24,8 @@ function New-VSEC2RouteTable { UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html#cfn-ec2-routetable-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 index 8f3051717..291c34b7a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 @@ -1,10 +1,16 @@ function New-VSEC2SecurityGroup { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroup resource to the template. + Adds an AWS::EC2::SecurityGroup resource to the template. Specifies a security group. To create a VPC security group, use the VpcId: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid property. .DESCRIPTION - Adds an AWS::EC2::SecurityGroup resource to the template. + Adds an AWS::EC2::SecurityGroup resource to the template. Specifies a security group. To create a VPC security group, use the VpcId: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid property. + +This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html. + +**Important** + +If you want to cross-reference two security groups in the ingress and egress rules of those security groups, use the AWS::EC2::SecurityGroupEgress: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html and AWS::EC2::SecurityGroupIngress: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-ingress.html resources to define your rules. Do not use the embedded ingress and egress rules in the AWS::EC2::SecurityGroup. Doing so creates a circular dependency, which CloudFormation doesn't allow. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html @@ -13,16 +19,28 @@ function New-VSEC2SecurityGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GroupDescription + A description for the security group. This is informational only. +Constraints: Up to 255 characters in length +Constraints for EC2-Classic: ASCII characters +Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=&;{}!$* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupdescription PrimitiveType: String UpdateType: Immutable .PARAMETER GroupName + The name of the security group. +Constraints: Up to 255 characters in length. Cannot start with sg-. +Constraints for EC2-Classic: ASCII characters +Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=&;{}!$* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupname PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroupEgress + VPC only] The outbound rules associated with the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupegress DuplicatesAllowed: True ItemType: Egress @@ -30,6 +48,8 @@ function New-VSEC2SecurityGroup { UpdateType: Mutable .PARAMETER SecurityGroupIngress + The inbound rules associated with the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupingress DuplicatesAllowed: True ItemType: Ingress @@ -37,6 +57,8 @@ function New-VSEC2SecurityGroup { UpdateType: Mutable .PARAMETER Tags + Any tags assigned to the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-tags DuplicatesAllowed: True ItemType: Tag @@ -44,6 +66,8 @@ function New-VSEC2SecurityGroup { UpdateType: Mutable .PARAMETER VpcId + VPC only] The ID of the VPC for the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 index 123899818..f1bafee4a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 @@ -1,10 +1,20 @@ function New-VSEC2SecurityGroupEgress { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroupEgress resource to the template. + Adds an AWS::EC2::SecurityGroupEgress resource to the template. EC2-VPC only] Adds the specified egress rules to a security group for use with a VPC. .DESCRIPTION - Adds an AWS::EC2::SecurityGroupEgress resource to the template. + Adds an AWS::EC2::SecurityGroupEgress resource to the template. EC2-VPC only] Adds the specified egress rules to a security group for use with a VPC. + +An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. + +You specify a protocol for each rule (for example, TCP. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. + +Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. + +For more information about VPC security group limits, see Amazon VPC Limits: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html. + +Use AWS::EC2::SecurityGroupIngress and AWS::EC2::SecurityGroupEgress only when necessary, typically to allow security groups to reference each other in ingress and egress rules. Otherwise, use the embedded ingress and egress rules of the security group. For more information, see Amazon EC2 Security Groups: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html @@ -13,46 +23,69 @@ function New-VSEC2SecurityGroupEgress { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CidrIp + The IPv4 ranges. +You must specify a destination security group DestinationPrefixListId or DestinationSecurityGroupId or a CIDR range CidrIp or CidrIpv6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidrip PrimitiveType: String UpdateType: Immutable .PARAMETER CidrIpv6 + The IPv6 ranges. +You must specify a destination security group DestinationPrefixListId or DestinationSecurityGroupId or a CIDR range CidrIp or CidrIpv6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidripv6 PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of an egress outbound security group rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-description PrimitiveType: String UpdateType: Mutable .PARAMETER DestinationPrefixListId + EC2-VPC only] The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. +You must specify a destination security group DestinationPrefixListId or DestinationSecurityGroupId or a CIDR range CidrIp or CidrIpv6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationprefixlistid PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationSecurityGroupId + The ID of the security group. +You must specify a destination security group DestinationPrefixListId or DestinationSecurityGroupId or a CIDR range CidrIp or CidrIpv6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid PrimitiveType: String UpdateType: Immutable .PARAMETER FromPort + The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-fromport PrimitiveType: Integer UpdateType: Immutable .PARAMETER GroupId + The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-groupid PrimitiveType: String UpdateType: Immutable .PARAMETER IpProtocol + The IP protocol name tcp, udp, icmp, icmpv6 or number see Protocol Numbers: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. +VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-ipprotocol PrimitiveType: String UpdateType: Immutable .PARAMETER ToPort + The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-toport PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 index a3eecaaf6..a116b59a9 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 @@ -1,10 +1,16 @@ function New-VSEC2SecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroupIngress resource to the template. + Adds an AWS::EC2::SecurityGroupIngress resource to the template. Adds the specified ingress rules to a security group. .DESCRIPTION - Adds an AWS::EC2::SecurityGroupIngress resource to the template. + Adds an AWS::EC2::SecurityGroupIngress resource to the template. Adds the specified ingress rules to a security group. + +An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from the specified destination security groups. + +You specify a protocol for each rule (for example, TCP. For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. + +Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html @@ -13,61 +19,96 @@ function New-VSEC2SecurityGroupIngress { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CidrIp + The IPv4 ranges. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidrip PrimitiveType: String UpdateType: Immutable .PARAMETER CidrIpv6 + VPC only] The IPv6 ranges. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidripv6 PrimitiveType: String UpdateType: Immutable .PARAMETER Description + Updates the description of an ingress inbound security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-description PrimitiveType: String UpdateType: Mutable .PARAMETER FromPort + The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. +Use this for ICMP and any protocol that uses ports. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-fromport PrimitiveType: Integer UpdateType: Immutable .PARAMETER GroupId + The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. +You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. For example, EC2-VPC: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html accounts must use the GroupId property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupid PrimitiveType: String UpdateType: Immutable .PARAMETER GroupName + The name of the security group. +Constraints: Up to 255 characters in length. Cannot start with sg-. +Constraints for EC2-Classic: ASCII characters +Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=&;{}!$* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupname PrimitiveType: String UpdateType: Immutable .PARAMETER IpProtocol + The IP protocol name tcp, udp, icmp, icmpv6 or number see Protocol Numbers: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. +VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-ipprotocol PrimitiveType: String UpdateType: Immutable .PARAMETER SourcePrefixListId + EC2-VPC only] The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. +You must specify a source security group SourcePrefixListId, SourceSecurityGroupId, or SourceSecurityGroupName or a CIDR range CidrIp or CidrIpv6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid PrimitiveType: String UpdateType: Immutable .PARAMETER SourceSecurityGroupId + The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. +If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupid PrimitiveType: String UpdateType: Immutable .PARAMETER SourceSecurityGroupName + EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC. +You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. For example, EC2-VPC: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html accounts must use the GroupId property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupname PrimitiveType: String UpdateType: Immutable .PARAMETER SourceSecurityGroupOwnerId + nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. +If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupownerid PrimitiveType: String UpdateType: Immutable .PARAMETER ToPort + The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes. +Use this for ICMP and any protocol that uses ports. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-toport PrimitiveType: Integer UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 index 20d969b15..cb026961d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 @@ -1,10 +1,22 @@ function New-VSEC2SpotFleet { <# .SYNOPSIS - Adds an AWS::EC2::SpotFleet resource to the template. + Adds an AWS::EC2::SpotFleet resource to the template. Specifies a Spot Fleet request. A Spot Fleet request contains the configuration information to launch a fleet, or group, of instances. .DESCRIPTION - Adds an AWS::EC2::SpotFleet resource to the template. + Adds an AWS::EC2::SpotFleet resource to the template. Specifies a Spot Fleet request. A Spot Fleet request contains the configuration information to launch a fleet, or group, of instances. + +The Spot Fleet request specifies the total target capacity and the On-Demand target capacity for the fleet. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity. + +The Spot Fleet request can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. + +By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. + +Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet. + +You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported. + +For more information, see Spot Fleet Requests: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html in the *Amazon EC2 User Guide for Linux Instances*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html @@ -13,6 +25,8 @@ function New-VSEC2SpotFleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SpotFleetRequestConfigData + Describes the configuration of a Spot Fleet request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata Type: SpotFleetRequestConfigData UpdateType: Conditional diff --git a/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 index dd012f1ad..a651af5f6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 @@ -1,10 +1,14 @@ function New-VSEC2Subnet { <# .SYNOPSIS - Adds an AWS::EC2::Subnet resource to the template. + Adds an AWS::EC2::Subnet resource to the template. Specifies a subnet for a VPC. .DESCRIPTION - Adds an AWS::EC2::Subnet resource to the template. + Adds an AWS::EC2::Subnet resource to the template. Specifies a subnet for a VPC. + +When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC you can create uses a /28 netmask (16 IPv4 addresses, and the largest uses a /16 netmask (65,536 IPv4 addresses. + +If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html @@ -13,31 +17,49 @@ function New-VSEC2Subnet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssignIpv6AddressOnCreation + Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false. +If you specify a true or false value for AssignIpv6AddressOnCreation, Ipv6CidrBlock must also be specified. +If AssignIpv6AddressOnCreation is specified, MapPublicIpOnLaunch cannot be specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AvailabilityZone + The Availability Zone of the subnet. +If you update this property, you must also update the CidrBlock property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER CidrBlock + The IPv4 CIDR block assigned to the subnet. +If you update this property, you must also update the AvailabilityZone property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER Ipv6CidrBlock + The IPv6 CIDR block. +If you specify a true or false value for AssignIpv6AddressOnCreation, Ipv6CidrBlock must be specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock PrimitiveType: String UpdateType: Mutable .PARAMETER MapPublicIpOnLaunch + Indicates whether instances launched in this subnet receive a public IPv4 address. +If MapPublicIpOnLaunch is specified. AssignIpv6AddressOnCreation cannot be specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Tags + Any tags assigned to the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags DuplicatesAllowed: True ItemType: Tag @@ -45,6 +67,9 @@ function New-VSEC2Subnet { UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC the subnet is in. +If you update this property, you must also update the CidrBlock property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-awsec2subnet-prop-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 index 4e1b37599..d5a95bf8a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 @@ -1,10 +1,10 @@ function New-VSEC2SubnetCidrBlock { <# .SYNOPSIS - Adds an AWS::EC2::SubnetCidrBlock resource to the template. + Adds an AWS::EC2::SubnetCidrBlock resource to the template. Associates a single IPv6 CIDR block with a VPC subnet. .DESCRIPTION - Adds an AWS::EC2::SubnetCidrBlock resource to the template. + Adds an AWS::EC2::SubnetCidrBlock resource to the template. Associates a single IPv6 CIDR block with a VPC subnet. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html @@ -13,11 +13,15 @@ function New-VSEC2SubnetCidrBlock { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Ipv6CidrBlock + The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetId + The ID of the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 index cbabd2a18..bc04718e2 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 @@ -1,10 +1,12 @@ function New-VSEC2SubnetNetworkAclAssociation { <# .SYNOPSIS - Adds an AWS::EC2::SubnetNetworkAclAssociation resource to the template. + Adds an AWS::EC2::SubnetNetworkAclAssociation resource to the template. Associates a subnet with a network ACL. For more information, see ReplaceNetworkAclAssociation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html in the *Amazon Elastic Compute Cloud API Reference*. .DESCRIPTION - Adds an AWS::EC2::SubnetNetworkAclAssociation resource to the template. + Adds an AWS::EC2::SubnetNetworkAclAssociation resource to the template. Associates a subnet with a network ACL. For more information, see ReplaceNetworkAclAssociation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html in the *Amazon Elastic Compute Cloud API Reference*. + +When AWS::EC2::SubnetNetworkAclAssociation resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource. However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using Retain deletion policies. For more information, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html @@ -13,11 +15,15 @@ function New-VSEC2SubnetNetworkAclAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER NetworkAclId + The ID of the network ACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-networkaclid PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetId + The ID of the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-associationid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 index fa426a4d2..ad10cc03c 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2SubnetRouteTableAssociation { <# .SYNOPSIS - Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. + Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. .DESCRIPTION - Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. + Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html @@ -13,11 +13,16 @@ function New-VSEC2SubnetRouteTableAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RouteTableId + The ID of the route table. +The physical ID changes when the route table ID is changed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html#cfn-ec2-subnetroutetableassociation-routetableid PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html#cfn-ec2-subnetroutetableassociation-subnetid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 index 1cbc6a2b5..676f952eb 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 @@ -1,10 +1,18 @@ function New-VSEC2TransitGateway { <# .SYNOPSIS - Adds an AWS::EC2::TransitGateway resource to the template. + Adds an AWS::EC2::TransitGateway resource to the template. Specifies a transit gateway. .DESCRIPTION - Adds an AWS::EC2::TransitGateway resource to the template. + Adds an AWS::EC2::TransitGateway resource to the template. Specifies a transit gateway. + +You can use a transit gateway to interconnect your virtual private clouds (VPC and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway. + +To attach your VPCs, use AWS::EC2::TransitGatewayAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html. + +To attach a VPN connection, use AWS::EC2::CustomerGateway: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to AWS::EC2::VPNConnection: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html. + +When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use AWS::EC2::TransitGatewayRouteTable: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use AWS::EC2::TransitGatewayRouteTablePropagation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AWS::EC2::TransitGatewayRouteTableAssociation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html to associate a resource attachment with a transit gateway route table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html @@ -13,41 +21,57 @@ function New-VSEC2TransitGateway { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DefaultRouteTablePropagation + Indicates whether resource attachments automatically propagate routes to the default propagation route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetablepropagation PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of the transit gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-description PrimitiveType: String UpdateType: Immutable .PARAMETER AutoAcceptSharedAttachments + Indicates whether attachment requests are automatically accepted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-autoacceptsharedattachments PrimitiveType: String UpdateType: Immutable .PARAMETER DefaultRouteTableAssociation + Indicates whether resource attachments are automatically associated with the default association route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetableassociation PrimitiveType: String UpdateType: Immutable .PARAMETER VpnEcmpSupport + Indicates whether Equal Cost Multipath Protocol support is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-vpnecmpsupport PrimitiveType: String UpdateType: Immutable .PARAMETER DnsSupport + Indicates whether DNS support is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-dnssupport PrimitiveType: String UpdateType: Immutable .PARAMETER AmazonSideAsn + A private Autonomous System Number ASN for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-amazonsideasn PrimitiveType: Integer UpdateType: Immutable .PARAMETER Tags + The tags for the transit gateway. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 index 10fbc7e0b..0c91bd4e5 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 @@ -1,10 +1,14 @@ function New-VSEC2TransitGatewayAttachment { <# .SYNOPSIS - Adds an AWS::EC2::TransitGatewayAttachment resource to the template. + Adds an AWS::EC2::TransitGatewayAttachment resource to the template. Attaches a VPC to a transit gateway. .DESCRIPTION - Adds an AWS::EC2::TransitGatewayAttachment resource to the template. + Adds an AWS::EC2::TransitGatewayAttachment resource to the template. Attaches a VPC to a transit gateway. + +If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table. + +To send VPC traffic to an attached transit gateway, add a route to the VPC route table using AWS::EC2::TransitGatewayRoute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html @@ -13,22 +17,30 @@ function New-VSEC2TransitGatewayAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TransitGatewayId + The ID of the transit gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-transitgatewayid PrimitiveType: String UpdateType: Immutable .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-vpcid PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetIds + The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-subnetids UpdateType: Immutable .PARAMETER Tags + The tags for the attachment. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 index e26073143..e5bc4c51b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 @@ -1,10 +1,10 @@ function New-VSEC2TransitGatewayRoute { <# .SYNOPSIS - Adds an AWS::EC2::TransitGatewayRoute resource to the template. + Adds an AWS::EC2::TransitGatewayRoute resource to the template. Specifies a static route for a transit gateway route table. .DESCRIPTION - Adds an AWS::EC2::TransitGatewayRoute resource to the template. + Adds an AWS::EC2::TransitGatewayRoute resource to the template. Specifies a static route for a transit gateway route table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html @@ -13,21 +13,29 @@ function New-VSEC2TransitGatewayRoute { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TransitGatewayRouteTableId + The ID of the transit gateway route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayroutetableid PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationCidrBlock + The CIDR block used for destination matches. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-destinationcidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER Blackhole + Indicates whether to drop traffic that matches this route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-blackhole PrimitiveType: Boolean UpdateType: Immutable .PARAMETER TransitGatewayAttachmentId + The ID of the attachment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayattachmentid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 index 1799b7dd1..332ec18db 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 @@ -1,10 +1,10 @@ function New-VSEC2TransitGatewayRouteTable { <# .SYNOPSIS - Adds an AWS::EC2::TransitGatewayRouteTable resource to the template. + Adds an AWS::EC2::TransitGatewayRouteTable resource to the template. Specifies a route table for a transit gateway. .DESCRIPTION - Adds an AWS::EC2::TransitGatewayRouteTable resource to the template. + Adds an AWS::EC2::TransitGatewayRouteTable resource to the template. Specifies a route table for a transit gateway. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html @@ -13,11 +13,15 @@ function New-VSEC2TransitGatewayRouteTable { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TransitGatewayId + The ID of the transit gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-transitgatewayid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Any tags assigned to the route table. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 index 87857dea7..1924dba3e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2TransitGatewayRouteTableAssociation { <# .SYNOPSIS - Adds an AWS::EC2::TransitGatewayRouteTableAssociation resource to the template. + Adds an AWS::EC2::TransitGatewayRouteTableAssociation resource to the template. Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. .DESCRIPTION - Adds an AWS::EC2::TransitGatewayRouteTableAssociation resource to the template. + Adds an AWS::EC2::TransitGatewayRouteTableAssociation resource to the template. Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html @@ -13,11 +13,15 @@ function New-VSEC2TransitGatewayRouteTableAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TransitGatewayRouteTableId + The ID of the route table for the transit gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayroutetableid PrimitiveType: String UpdateType: Immutable .PARAMETER TransitGatewayAttachmentId + The ID of the attachment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayattachmentid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 index e6eb0fc87..b50c9300e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 @@ -1,10 +1,12 @@ function New-VSEC2TransitGatewayRouteTablePropagation { <# .SYNOPSIS - Adds an AWS::EC2::TransitGatewayRouteTablePropagation resource to the template. + Adds an AWS::EC2::TransitGatewayRouteTablePropagation resource to the template. Enables the specified attachment to propagate routes to the specified propagation route table. .DESCRIPTION - Adds an AWS::EC2::TransitGatewayRouteTablePropagation resource to the template. + Adds an AWS::EC2::TransitGatewayRouteTablePropagation resource to the template. Enables the specified attachment to propagate routes to the specified propagation route table. + +For more information about enabling transit gateway route propagation, see EnableVgwRoutePropagation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableTransitGatewayRouteTablePropagation.html in the *Amazon Elastic Compute Cloud API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html @@ -13,11 +15,15 @@ function New-VSEC2TransitGatewayRouteTablePropagation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TransitGatewayRouteTableId + The ID of the propagation route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayroutetableid PrimitiveType: String UpdateType: Immutable .PARAMETER TransitGatewayAttachmentId + The ID of the attachment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayattachmentid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 index 8d3c4c34d..83ed275aa 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 @@ -1,10 +1,10 @@ function New-VSEC2VPC { <# .SYNOPSIS - Adds an AWS::EC2::VPC resource to the template. + Adds an AWS::EC2::VPC resource to the template. Specifies a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses, and the largest uses a /16 netmask (65,536 IPv4 addresses. For more information about how large to make your VPC, see Your VPC and Subnets: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html in the *Amazon Virtual Private Cloud User Guide*. .DESCRIPTION - Adds an AWS::EC2::VPC resource to the template. + Adds an AWS::EC2::VPC resource to the template. Specifies a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses, and the largest uses a /16 netmask (65,536 IPv4 addresses. For more information about how large to make your VPC, see Your VPC and Subnets: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html in the *Amazon Virtual Private Cloud User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html @@ -13,26 +13,40 @@ function New-VSEC2VPC { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CidrBlock + The primary IPv4 CIDR block for the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-cidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER EnableDnsHostnames + Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. +You can only enable DNS hostnames if you've enabled DNS support. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsHostnames PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EnableDnsSupport + Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsSupport PrimitiveType: Boolean UpdateType: Mutable .PARAMETER InstanceTenancy + The allowed tenancy of instances launched into the VPC. ++ "default": Instances can be launched with any tenancy. ++ "dedicated": Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy. +Updating InstanceTenancy requires no replacement only if you are updating its value from "dedicated" to "default". Updating InstanceTenancy from "default" to "dedicated" requires replacement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-instancetenancy PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags for the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 index e8dd847e9..27546df0a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPCCidrBlock { <# .SYNOPSIS - Adds an AWS::EC2::VPCCidrBlock resource to the template. + Adds an AWS::EC2::VPCCidrBlock resource to the template. Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. An IPv6 CIDR block must have a prefix length of /64. .DESCRIPTION - Adds an AWS::EC2::VPCCidrBlock resource to the template. + Adds an AWS::EC2::VPCCidrBlock resource to the template. Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. An IPv6 CIDR block must have a prefix length of /64. + +For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing in the *Amazon Virtual Private Cloud User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html @@ -13,16 +15,22 @@ function New-VSEC2VPCCidrBlock { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AmazonProvidedIpv6CidrBlock + Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock PrimitiveType: Boolean UpdateType: Immutable .PARAMETER CidrBlock + An IPv4 CIDR block to associate with the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 index a10f5122f..cc169b202 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPCDHCPOptionsAssociation { <# .SYNOPSIS - Adds an AWS::EC2::VPCDHCPOptionsAssociation resource to the template. + Adds an AWS::EC2::VPCDHCPOptionsAssociation resource to the template. Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC. .DESCRIPTION - Adds an AWS::EC2::VPCDHCPOptionsAssociation resource to the template. + Adds an AWS::EC2::VPCDHCPOptionsAssociation resource to the template. Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC. + +After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html @@ -13,11 +15,15 @@ function New-VSEC2VPCDHCPOptionsAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DhcpOptionsId + The ID of the DHCP options set, or default to associate no DHCP options with the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid PrimitiveType: String UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 index b41d71b7c..e09a6e661 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 @@ -1,10 +1,14 @@ function New-VSEC2VPCEndpoint { <# .SYNOPSIS - Adds an AWS::EC2::VPCEndpoint resource to the template. + Adds an AWS::EC2::VPCEndpoint resource to the template. Specifies a VPC endpoint for a service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html in the *Amazon Virtual Private Cloud User Guide*. .DESCRIPTION - Adds an AWS::EC2::VPCEndpoint resource to the template. + Adds an AWS::EC2::VPCEndpoint resource to the template. Specifies a VPC endpoint for a service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html in the *Amazon Virtual Private Cloud User Guide*. + +A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. + +An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html @@ -13,16 +17,24 @@ function New-VSEC2VPCEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PolicyDocument + A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER PrivateDnsEnabled + Interface endpoint Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region for example, kinesis.us-east-1.amazonaws.com which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. +To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. +Default: true + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RouteTableIds + Gateway endpoint One or more route table IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids DuplicatesAllowed: False PrimitiveItemType: String @@ -30,6 +42,8 @@ function New-VSEC2VPCEndpoint { UpdateType: Mutable .PARAMETER SecurityGroupIds + Interface endpoint The ID of one or more security groups to associate with the endpoint network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids DuplicatesAllowed: False PrimitiveItemType: String @@ -37,11 +51,15 @@ function New-VSEC2VPCEndpoint { UpdateType: Mutable .PARAMETER ServiceName + The service name. To get a list of available services, use the DescribeVpcEndpointServices: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpointServices.html request, or get the name from the service provider. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetIds + Interface endpoint The ID of one or more subnets in which to create an endpoint network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids DuplicatesAllowed: False PrimitiveItemType: String @@ -49,11 +67,16 @@ function New-VSEC2VPCEndpoint { UpdateType: Mutable .PARAMETER VpcEndpointType + The type of endpoint. +Default: Gateway + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype PrimitiveType: String UpdateType: Immutable .PARAMETER VpcId + The ID of the VPC in which the endpoint will be used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 index ef8e08edf..3e3e8570a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPCEndpointConnectionNotification { <# .SYNOPSIS - Adds an AWS::EC2::VPCEndpointConnectionNotification resource to the template. + Adds an AWS::EC2::VPCEndpointConnectionNotification resource to the template. Specifies a connection notification for a VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html in the *Amazon Simple Notification Service Developer Guide*. .DESCRIPTION - Adds an AWS::EC2::VPCEndpointConnectionNotification resource to the template. + Adds an AWS::EC2::VPCEndpointConnectionNotification resource to the template. Specifies a connection notification for a VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html in the *Amazon Simple Notification Service Developer Guide*. + +You can create a connection notification for interface endpoints only. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html @@ -13,22 +15,30 @@ function New-VSEC2VPCEndpointConnectionNotification { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConnectionEvents + One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionevents UpdateType: Mutable .PARAMETER VPCEndpointId + The ID of the endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-vpcendpointid PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceId + The ID of the endpoint service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-serviceid PrimitiveType: String UpdateType: Immutable .PARAMETER ConnectionNotificationArn + The ARN of the SNS topic for the notifications. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionnotificationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 index 9cf737a12..28bbb8b0a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPCEndpointService { <# .SYNOPSIS - Adds an AWS::EC2::VPCEndpointService resource to the template. + Adds an AWS::EC2::VPCEndpointService resource to the template. Specifies a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles can connect. Service consumers can create an interface VPC endpoint to connect to your service. .DESCRIPTION - Adds an AWS::EC2::VPCEndpointService resource to the template. + Adds an AWS::EC2::VPCEndpointService resource to the template. Specifies a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles can connect. Service consumers can create an interface VPC endpoint to connect to your service. + +To create an endpoint service configuration, you must first create a Network Load Balancer for your service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html @@ -13,12 +15,16 @@ function New-VSEC2VPCEndpointService { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER NetworkLoadBalancerArns + The Amazon Resource Names ARNs of one or more Network Load Balancers for your service. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-networkloadbalancerarns UpdateType: Mutable .PARAMETER AcceptanceRequired + Indicates whether requests from service consumers to create an endpoint to your service must be accepted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-acceptancerequired PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 index 21c8f15da..8b742390c 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPCEndpointServicePermissions { <# .SYNOPSIS - Adds an AWS::EC2::VPCEndpointServicePermissions resource to the template. + Adds an AWS::EC2::VPCEndpointServicePermissions resource to the template. Grant or revoke permissions for service consumers (IAM users, IAM roles, and AWS accounts to connect to a VPC endpoint service. .DESCRIPTION - Adds an AWS::EC2::VPCEndpointServicePermissions resource to the template. + Adds an AWS::EC2::VPCEndpointServicePermissions resource to the template. Grant or revoke permissions for service consumers (IAM users, IAM roles, and AWS accounts to connect to a VPC endpoint service. + +If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html @@ -13,12 +15,16 @@ function New-VSEC2VPCEndpointServicePermissions { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AllowedPrincipals + The Amazon Resource Names ARN of one or more principals IAM users, IAM roles, and AWS accounts. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk *. Permissions are revoked for principals not in this list. If the list is empty, then all permissions are revoked. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-allowedprincipals UpdateType: Mutable .PARAMETER ServiceId + The ID of the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-serviceid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 index 4cdd3da3a..764f5483b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 @@ -1,10 +1,10 @@ function New-VSEC2VPCGatewayAttachment { <# .SYNOPSIS - Adds an AWS::EC2::VPCGatewayAttachment resource to the template. + Adds an AWS::EC2::VPCGatewayAttachment resource to the template. Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. .DESCRIPTION - Adds an AWS::EC2::VPCGatewayAttachment resource to the template. + Adds an AWS::EC2::VPCGatewayAttachment resource to the template. Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html @@ -13,16 +13,24 @@ function New-VSEC2VPCGatewayAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InternetGatewayId + The ID of the internet gateway. +You must specify either InternetGatewayId or VpnGatewayId, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid PrimitiveType: String UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpcid PrimitiveType: String UpdateType: Mutable .PARAMETER VpnGatewayId + The ID of the virtual private gateway. +You must specify either InternetGatewayId or VpnGatewayId, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 index 30f3f1fd0..521bc34dd 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 @@ -1,10 +1,18 @@ function New-VSEC2VPCPeeringConnection { <# .SYNOPSIS - Adds an AWS::EC2::VPCPeeringConnection resource to the template. + Adds an AWS::EC2::VPCPeeringConnection resource to the template. Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. .DESCRIPTION - Adds an AWS::EC2::VPCPeeringConnection resource to the template. + Adds an AWS::EC2::VPCPeeringConnection resource to the template. Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. + +**Note** + +Limitations and rules apply to a VPC peering connection. For more information, see the limitations: https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations section in the *VPC Peering Guide*. + +The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. + +If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html @@ -13,26 +21,38 @@ function New-VSEC2VPCPeeringConnection { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PeerOwnerId + The AWS account ID of the owner of the accepter VPC. +Default: Your AWS account ID + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid PrimitiveType: String UpdateType: Immutable .PARAMETER PeerRegion + The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. +Default: The Region in which you make the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion PrimitiveType: String UpdateType: Immutable .PARAMETER PeerRoleArn + The Amazon Resource Name ARN of the VPC peer role for the peering connection in another AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn PrimitiveType: String UpdateType: Immutable .PARAMETER PeerVpcId + The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Any tags assigned to the resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags DuplicatesAllowed: True ItemType: Tag @@ -40,6 +60,8 @@ function New-VSEC2VPCPeeringConnection { UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 index 39cccb835..6dece4130 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPNConnection { <# .SYNOPSIS - Adds an AWS::EC2::VPNConnection resource to the template. + Adds an AWS::EC2::VPNConnection resource to the template. Specifies a VPN connection between a virtual private gateway and a VPN customer gateway. .DESCRIPTION - Adds an AWS::EC2::VPNConnection resource to the template. + Adds an AWS::EC2::VPNConnection resource to the template. Specifies a VPN connection between a virtual private gateway and a VPN customer gateway. + +For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html in the *AWS Site-to-Site VPN User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html @@ -13,16 +15,23 @@ function New-VSEC2VPNConnection { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CustomerGatewayId + The ID of the customer gateway at your end of the VPN connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-customergatewayid PrimitiveType: String UpdateType: Immutable .PARAMETER StaticRoutesOnly + Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. +If you are creating a VPN connection for a device that does not support Border Gateway Protocol BGP, you must specify true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-StaticRoutesOnly PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Tags + Any tags assigned to the VPN connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-tags DuplicatesAllowed: True ItemType: Tag @@ -30,21 +39,31 @@ function New-VSEC2VPNConnection { UpdateType: Mutable .PARAMETER TransitGatewayId + The ID of the transit gateway associated with the VPN connection. +You must specify either TransitGatewayId or VpnGatewayId, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-transitgatewayid PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The type of VPN connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-type PrimitiveType: String UpdateType: Immutable .PARAMETER VpnGatewayId + The ID of the virtual private gateway at the AWS side of the VPN connection. +You must specify either TransitGatewayId or VpnGatewayId, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpngatewayid PrimitiveType: String UpdateType: Immutable .PARAMETER VpnTunnelOptionsSpecifications + The tunnel options for a VPN connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications DuplicatesAllowed: False ItemType: VpnTunnelOptionsSpecification diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 index a4080e04b..39155d485 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPNConnectionRoute { <# .SYNOPSIS - Adds an AWS::EC2::VPNConnectionRoute resource to the template. + Adds an AWS::EC2::VPNConnectionRoute resource to the template. Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. .DESCRIPTION - Adds an AWS::EC2::VPNConnectionRoute resource to the template. + Adds an AWS::EC2::VPNConnectionRoute resource to the template. Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. + +For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html in the *AWS Site-to-Site VPN User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html @@ -13,11 +15,15 @@ function New-VSEC2VPNConnectionRoute { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DestinationCidrBlock + The CIDR block associated with the local subnet of the customer network. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html#cfn-ec2-vpnconnectionroute-cidrblock PrimitiveType: String UpdateType: Immutable .PARAMETER VpnConnectionId + The ID of the VPN connection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html#cfn-ec2-vpnconnectionroute-connectionid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 index f2a9e0ba3..bc4ebc783 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPNGateway { <# .SYNOPSIS - Adds an AWS::EC2::VPNGateway resource to the template. + Adds an AWS::EC2::VPNGateway resource to the template. Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. .DESCRIPTION - Adds an AWS::EC2::VPNGateway resource to the template. + Adds an AWS::EC2::VPNGateway resource to the template. Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. + +For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html in the *AWS Site-to-Site VPN User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html @@ -13,11 +15,15 @@ function New-VSEC2VPNGateway { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AmazonSideAsn + The private Autonomous System Number ASN for the Amazon side of a BGP session. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-amazonsideasn PrimitiveType: Long UpdateType: Immutable .PARAMETER Tags + Any tags assigned to the virtual private gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-tags DuplicatesAllowed: True ItemType: Tag @@ -25,6 +31,8 @@ function New-VSEC2VPNGateway { UpdateType: Mutable .PARAMETER Type + The type of VPN connection the virtual private gateway supports. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 index fa4c45708..3f7fb1a6c 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 @@ -1,10 +1,12 @@ function New-VSEC2VPNGatewayRoutePropagation { <# .SYNOPSIS - Adds an AWS::EC2::VPNGatewayRoutePropagation resource to the template. + Adds an AWS::EC2::VPNGatewayRoutePropagation resource to the template. Enables a virtual private gateway (VGW to propagate routes to the specified route table of a VPC. .DESCRIPTION - Adds an AWS::EC2::VPNGatewayRoutePropagation resource to the template. + Adds an AWS::EC2::VPNGatewayRoutePropagation resource to the template. Enables a virtual private gateway (VGW to propagate routes to the specified route table of a VPC. + +If you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The AWS::EC2::VPNGatewayRoutePropagation resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html in the AWS::EC2::VPNGatewayRoutePropagation resource to explicitly declare a dependency on the VPN gateway attachment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html @@ -13,6 +15,8 @@ function New-VSEC2VPNGatewayRoutePropagation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RouteTableIds + The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html#cfn-ec2-vpngatewayrouteprop-routetableids DuplicatesAllowed: True PrimitiveItemType: String @@ -20,6 +24,8 @@ function New-VSEC2VPNGatewayRoutePropagation { UpdateType: Mutable .PARAMETER VpnGatewayId + The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html#cfn-ec2-vpngatewayrouteprop-vpngatewayid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 index 1eafff98c..ed094d8ac 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 @@ -1,10 +1,30 @@ function New-VSEC2Volume { <# .SYNOPSIS - Adds an AWS::EC2::Volume resource to the template. + Adds an AWS::EC2::Volume resource to the template. Specifies an Amazon Elastic Block Store (Amazon EBS volume. .DESCRIPTION - Adds an AWS::EC2::Volume resource to the template. + Adds an AWS::EC2::Volume resource to the template. Specifies an Amazon Elastic Block Store (Amazon EBS volume. + +When you use AWS CloudFormation to update an Amazon EBS volume that modifies Iops, Size, or VolumeType, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time. + +Amazon EBS does not support modifying a Magnetic volume. For more information, see Requirements for Modifying EBS Volumes: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-volume-requirements.html. + +Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation will not attempt to modify an Amazon EBS volume to a smaller size on rollback. + +Some common scenarios when you might encounter a cooldown period for Amazon EBS include: + ++ You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period. + ++ You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period. + +For more information on the cooldown period, see Requirements for Modifying EBS Volumes: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-volume-requirements.html. + +To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. + +**Note** + +If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html @@ -13,41 +33,69 @@ function New-VSEC2Volume { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoEnableIO + Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-autoenableio PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AvailabilityZone + The Availability Zone in which to create the volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER Encrypted + Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin new or from a snapshot, starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default in the *Amazon Elastic Compute Cloud User Guide*. +Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops + The number of I/O operations per second IOPS to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon Elastic Compute Cloud User Guide*. +This parameter is valid only for Provisioned IOPS SSD io1 volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER KmsKeyId + The identifier of the AWS Key Management Service AWS KMS customer master key CMK to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true. +You can specify the CMK using any of the following: ++ Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab. ++ Key alias. For example, alias/ExampleAlias. ++ Key ARN. For example, arn:aws:kms:*us-east-1*:*012345678910*:key/*abcd1234-a123-456a-a12b-a123b4cd56ef*. ++ Alias ARN. For example, arn:aws:kms:*us-east-1*:*012345678910*:alias/*ExampleAlias*. +AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-kmskeyid PrimitiveType: String UpdateType: Mutable .PARAMETER Size + The size of the volume, in GiBs. +Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. +Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. +At least one of Size or SnapshotId is required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-size PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotId + The snapshot from which to create the volume. +At least one of Size or SnapshotId are required. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-snapshotid PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to apply to the volume during creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-tags DuplicatesAllowed: True ItemType: Tag @@ -55,6 +103,9 @@ function New-VSEC2Volume { UpdateType: Mutable .PARAMETER VolumeType + The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes. +Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-volumetype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 index 177b55537..26ab0b810 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 @@ -1,10 +1,16 @@ function New-VSEC2VolumeAttachment { <# .SYNOPSIS - Adds an AWS::EC2::VolumeAttachment resource to the template. + Adds an AWS::EC2::VolumeAttachment resource to the template. Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name. .DESCRIPTION - Adds an AWS::EC2::VolumeAttachment resource to the template. + Adds an AWS::EC2::VolumeAttachment resource to the template. Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name. + +Before this resource can be deleted (and therefore the volume detached, you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains. + +If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first. + +If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no longer associated with the instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html @@ -13,16 +19,22 @@ function New-VSEC2VolumeAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Device + The device name for example, /dev/sdh or xvdh. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-device PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceId + The ID of the instance to which the volume attaches. This value can be a reference to an AWS::EC2::Instance resource, or it can be the physical ID of an existing EC2 instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-instanceid PrimitiveType: String UpdateType: Immutable .PARAMETER VolumeId + The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an AWS::EC2::Volume resource, or it can be the volume ID of an existing Amazon EBS volume. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-volumeid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 b/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 index 0abb1cff4..104b857d9 100644 --- a/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 @@ -1,10 +1,10 @@ function New-VSECRRepository { <# .SYNOPSIS - Adds an AWS::ECR::Repository resource to the template. + Adds an AWS::ECR::Repository resource to the template. The AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR repository, where users can push and pull Docker images. For more information, see Amazon ECR Repositories: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html in the *Amazon Elastic Container Registry User Guide*. .DESCRIPTION - Adds an AWS::ECR::Repository resource to the template. + Adds an AWS::ECR::Repository resource to the template. The AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR repository, where users can push and pull Docker images. For more information, see Amazon ECR Repositories: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html in the *Amazon Elastic Container Registry User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html @@ -13,21 +13,30 @@ function New-VSECRRepository { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LifecyclePolicy + Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy Type: LifecyclePolicy UpdateType: Mutable .PARAMETER RepositoryName + The name to use for the repository. The repository name may be specified on its own such as nginx-web-app or it can be prepended with a namespace to group the repository into a category such as project-a/nginx-web-app. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname PrimitiveType: String UpdateType: Immutable .PARAMETER RepositoryPolicyText + The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository Policy Examples: https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the *Amazon Elastic Container Registry User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 b/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 index 2bb0781c5..f531625b8 100644 --- a/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 @@ -1,10 +1,10 @@ function New-VSECSCluster { <# .SYNOPSIS - Adds an AWS::ECS::Cluster resource to the template. + Adds an AWS::ECS::Cluster resource to the template. The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS cluster. .DESCRIPTION - Adds an AWS::ECS::Cluster resource to the template. + Adds an AWS::ECS::Cluster resource to the template. The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html @@ -13,6 +13,8 @@ function New-VSECSCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClusterName + A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustername PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSECSService.ps1 b/VaporShell/Public/Resource Types/New-VSECSService.ps1 index 86268f485..1bd7d2148 100644 --- a/VaporShell/Public/Resource Types/New-VSECSService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSService.ps1 @@ -1,10 +1,10 @@ function New-VSECSService { <# .SYNOPSIS - Adds an AWS::ECS::Service resource to the template. + Adds an AWS::ECS::Service resource to the template. The AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS service that runs and maintains the requested number of tasks and associated load balancers. .DESCRIPTION - Adds an AWS::ECS::Service resource to the template. + Adds an AWS::ECS::Service resource to the template. The AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS service that runs and maintains the requested number of tasks and associated load balancers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html @@ -13,11 +13,15 @@ function New-VSECSService { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Cluster + The short name or full Amazon Resource Name ARN of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster PrimitiveType: String UpdateType: Immutable .PARAMETER DeploymentConfiguration + Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration Type: DeploymentConfiguration UpdateType: Mutable @@ -28,6 +32,8 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER DesiredCount + The number of instantiations of the specified task definition to place and keep running on your cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount PrimitiveType: Integer UpdateType: Mutable @@ -38,16 +44,22 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER HealthCheckGracePeriodSeconds + The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER LaunchType + The launch type on which to run your service. For more information, see Amazon ECS Launch Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype PrimitiveType: String UpdateType: Immutable .PARAMETER LoadBalancers + A list of load balancer objects to associate with the cluster. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers DuplicatesAllowed: False ItemType: LoadBalancer @@ -55,11 +67,15 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER NetworkConfiguration + The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration Type: NetworkConfiguration UpdateType: Mutable .PARAMETER PlacementConstraints + An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task this limit includes constraints in the task definition and those specified at runtime. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints DuplicatesAllowed: False ItemType: PlacementConstraint @@ -67,6 +83,8 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER PlacementStrategies + The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies DuplicatesAllowed: False ItemType: PlacementStrategy @@ -74,6 +92,8 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER PlatformVersion + The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion PrimitiveType: String UpdateType: Immutable @@ -84,21 +104,37 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER Role + The name or full Amazon Resource Name ARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. +If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html in the *Amazon Elastic Container Service Developer Guide*. +If your specified role has a path other than /, then you must either specify the full role ARN this is recommended or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role PrimitiveType: String UpdateType: Immutable .PARAMETER SchedulingStrategy + The scheduling strategy to use for the service. For more information, see Services: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html. +There are two service scheduler strategies available: ++ REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types. ++ DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. +**Note** +Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-schedulingstrategy PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceName + The name of your service. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceRegistries + The details of the service discovery registries to assign to this service. For more information, see Service Discovery: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. +Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries DuplicatesAllowed: False ItemType: ServiceRegistry @@ -113,6 +149,9 @@ function New-VSECSService { UpdateType: Mutable .PARAMETER TaskDefinition + The family and revision family:revision or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. +A task definition must be specified if the service is using the ECS deployment controller. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 index 0668f019e..d4976c473 100644 --- a/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 @@ -1,10 +1,10 @@ function New-VSECSTaskDefinition { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition resource to the template. + Adds an AWS::ECS::TaskDefinition resource to the template. The AWS::ECS::TaskDefinition resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task. .DESCRIPTION - Adds an AWS::ECS::TaskDefinition resource to the template. + Adds an AWS::ECS::TaskDefinition resource to the template. The AWS::ECS::TaskDefinition resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html @@ -13,6 +13,8 @@ function New-VSECSTaskDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ContainerDefinitions + A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-containerdefinitions DuplicatesAllowed: False ItemType: ContainerDefinition @@ -25,11 +27,16 @@ function New-VSECSTaskDefinition { UpdateType: Immutable .PARAMETER ExecutionRoleArn + The Amazon Resource Name ARN of the task execution role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn PrimitiveType: String UpdateType: Immutable .PARAMETER Family + The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. +To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family PrimitiveType: String UpdateType: Immutable @@ -42,26 +49,50 @@ function New-VSECSTaskDefinition { UpdateType: Immutable .PARAMETER IpcMode + The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc in the *Docker run reference*. +If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security: https://docs.docker.com/engine/security/security/. +If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html in the *Amazon Elastic Container Service Developer Guide*. ++ For tasks that use the host IPC mode, IPC namespace related systemControls are not supported. ++ For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task. +This parameter is not supported for Windows containers or tasks using the Fargate launch type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ipcmode PrimitiveType: String UpdateType: Immutable .PARAMETER Memory + The amount in MiB of memory used by the task. +If using the EC2 launch type, this field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-memory PrimitiveType: String UpdateType: Immutable .PARAMETER NetworkMode + The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. +With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port for the host network mode or the attached elastic network interface port for the awsvpc network mode, so you cannot take advantage of dynamic host port mappings. +If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html value when you create a service or run a task with the task definition. For more information, see Task Networking: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html in the *Amazon Elastic Container Service Developer Guide*. +Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode. +If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. +Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the network mode object. +For more information, see Network settings: https://docs.docker.com/engine/reference/run/#network-settings in the *Docker run reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-networkmode PrimitiveType: String UpdateType: Immutable .PARAMETER PidMode + The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings: https://docs.docker.com/engine/reference/run/#pid-settings---pid in the *Docker run reference*. +If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security: https://docs.docker.com/engine/security/security/. +This parameter is not supported for Windows containers or tasks using the Fargate launch type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-pidmode PrimitiveType: String UpdateType: Immutable .PARAMETER PlacementConstraints + An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-placementconstraints DuplicatesAllowed: False ItemType: TaskDefinitionPlacementConstraint @@ -69,11 +100,16 @@ function New-VSECSTaskDefinition { UpdateType: Immutable .PARAMETER ProxyConfiguration + The ProxyConfiguration property specifies the configuration details for the App Mesh proxy. +Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-proxyconfiguration Type: ProxyConfiguration UpdateType: Immutable .PARAMETER RequiresCompatibilities + The launch type the task requires. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-requirescompatibilities DuplicatesAllowed: False PrimitiveItemType: String @@ -81,6 +117,16 @@ function New-VSECSTaskDefinition { UpdateType: Immutable .PARAMETER Tags + The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. +The following basic restrictions apply to tags: ++ Maximum number of tags per resource - 50 ++ For each resource, each tag key must be unique, and each tag key can have only one value. ++ Maximum key length - 128 Unicode characters in UTF-8 ++ Maximum value length - 256 Unicode characters in UTF-8 ++ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. ++ Tag keys and values are case-sensitive. ++ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-tags DuplicatesAllowed: True ItemType: Tag @@ -88,11 +134,18 @@ function New-VSECSTaskDefinition { UpdateType: Mutable .PARAMETER TaskRoleArn + The short name or full Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_IAM_role.html in the *Amazon Elastic Container Service Developer Guide*. +IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn PrimitiveType: String UpdateType: Immutable .PARAMETER Volumes + The list of volume definitions for the task. +If your tasks are using the Fargate launch type, the host and sourcePath parameters are not supported. +For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-volumes DuplicatesAllowed: False ItemType: Volume diff --git a/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 b/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 index cea38ab94..e3decedfe 100644 --- a/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 @@ -1,10 +1,10 @@ function New-VSEFSFileSystem { <# .SYNOPSIS - Adds an AWS::EFS::FileSystem resource to the template. + Adds an AWS::EFS::FileSystem resource to the template. The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System (Amazon EFS. You must create a mount target (AWS::EFS::MountTarget: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html to mount your EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2 instance or another resource. .DESCRIPTION - Adds an AWS::EFS::FileSystem resource to the template. + Adds an AWS::EFS::FileSystem resource to the template. The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System (Amazon EFS. You must create a mount target (AWS::EFS::MountTarget: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html to mount your EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2 instance or another resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html @@ -13,11 +13,15 @@ function New-VSEFSFileSystem { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Encrypted + A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS Key Management Service AWS KMS customer master key CMK. If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-encrypted PrimitiveType: Boolean UpdateType: Immutable .PARAMETER FileSystemTags + A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemtags DuplicatesAllowed: False ItemType: ElasticFileSystemTag @@ -30,6 +34,8 @@ function New-VSEFSFileSystem { UpdateType: Immutable .PARAMETER LifecyclePolicies + + Creating an Amazon Elastic File System: https://docs.aws.amazon.com/efs/latest/ug/creating-using-fs.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-elasticfilesystem-filesystem-lifecyclepolicies DuplicatesAllowed: False ItemType: LifecyclePolicy @@ -37,16 +43,22 @@ function New-VSEFSFileSystem { UpdateType: Mutable .PARAMETER PerformanceMode + The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-performancemode PrimitiveType: String UpdateType: Immutable .PARAMETER ProvisionedThroughputInMibps + The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits in the *Amazon EFS User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-elasticfilesystem-filesystem-provisionedthroughputinmibps PrimitiveType: Double UpdateType: Mutable .PARAMETER ThroughputMode + The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput with Provisioned Mode: https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput in the *Amazon EFS User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-elasticfilesystem-filesystem-throughputmode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 b/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 index 6fa06c1ab..2f128e311 100644 --- a/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 @@ -1,10 +1,10 @@ function New-VSEFSMountTarget { <# .SYNOPSIS - Adds an AWS::EFS::MountTarget resource to the template. + Adds an AWS::EFS::MountTarget resource to the template. The AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target. .DESCRIPTION - Adds an AWS::EFS::MountTarget resource to the template. + Adds an AWS::EFS::MountTarget resource to the template. The AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html @@ -13,16 +13,22 @@ function New-VSEFSMountTarget { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FileSystemId + The ID of the file system for which to create the mount target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-filesystemid PrimitiveType: String UpdateType: Immutable .PARAMETER IpAddress + Valid IPv4 address within the address range of the specified subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddress PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroups + Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-securitygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -30,6 +36,8 @@ function New-VSEFSMountTarget { UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet to add the mount target in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-subnetid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 b/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 index 93e4eec22..3903c0093 100644 --- a/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 @@ -1,10 +1,18 @@ function New-VSEKSCluster { <# .SYNOPSIS - Adds an AWS::EKS::Cluster resource to the template. + Adds an AWS::EKS::Cluster resource to the template. Creates an Amazon EKS control plane. .DESCRIPTION - Adds an AWS::EKS::Cluster resource to the template. + Adds an AWS::EKS::Cluster resource to the template. Creates an Amazon EKS control plane. + +The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances. + +The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows. + +Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster. + +Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication: https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html and Launching Amazon EKS Worker Nodes: https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html in the *Amazon EKS User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html @@ -13,21 +21,29 @@ function New-VSEKSCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Version + The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-version PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role: https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html in the * *Amazon EKS User Guide* *. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-rolearn PrimitiveType: String UpdateType: Immutable .PARAMETER ResourcesVpcConfig + The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html and Cluster Security Group Considerations: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html in the *Amazon EKS User Guide*. You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane. + Type: ResourcesVpcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-resourcesvpcconfig UpdateType: Immutable .PARAMETER Name + The unique name to give to your cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 b/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 index ae165aa77..b5fbc7475 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 @@ -1,10 +1,10 @@ function New-VSEMRCluster { <# .SYNOPSIS - Adds an AWS::EMR::Cluster resource to the template. + Adds an AWS::EMR::Cluster resource to the template. The AWS::EMR::Cluster resource specifies an Amazon EMR cluster. This cluster is a collection of Amazon EC2 instances that run open source big data frameworks and applications to process and analyze vast amounts of data. For more information, see the Amazon EMR Management Guide: https://docs.aws.amazon.com/emr/latest/ManagementGuide/. .DESCRIPTION - Adds an AWS::EMR::Cluster resource to the template. + Adds an AWS::EMR::Cluster resource to the template. The AWS::EMR::Cluster resource specifies an Amazon EMR cluster. This cluster is a collection of Amazon EC2 instances that run open source big data frameworks and applications to process and analyze vast amounts of data. For more information, see the Amazon EMR Management Guide: https://docs.aws.amazon.com/emr/latest/ManagementGuide/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html @@ -13,11 +13,15 @@ function New-VSEMRCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AdditionalInfo + A JSON string for selecting additional features. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-additionalinfo PrimitiveType: Json UpdateType: Immutable .PARAMETER Applications + The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-applications DuplicatesAllowed: False ItemType: Application @@ -25,11 +29,15 @@ function New-VSEMRCluster { UpdateType: Immutable .PARAMETER AutoScalingRole + An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-autoscalingrole PrimitiveType: String UpdateType: Immutable .PARAMETER BootstrapActions + A list of bootstrap actions to run before Hadoop starts on the cluster nodes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-bootstrapactions DuplicatesAllowed: False ItemType: BootstrapActionConfig @@ -37,6 +45,8 @@ function New-VSEMRCluster { UpdateType: Immutable .PARAMETER Configurations + Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-configurations DuplicatesAllowed: False ItemType: Configuration @@ -44,61 +54,85 @@ function New-VSEMRCluster { UpdateType: Immutable .PARAMETER CustomAmiId + Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-customamiid PrimitiveType: String UpdateType: Immutable .PARAMETER EbsRootVolumeSize + The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-ebsrootvolumesize PrimitiveType: Integer UpdateType: Immutable .PARAMETER Instances + A specification of the number and type of Amazon EC2 instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-instances Type: JobFlowInstancesConfig UpdateType: Conditional .PARAMETER JobFlowRole + Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-jobflowrole PrimitiveType: String UpdateType: Immutable .PARAMETER KerberosAttributes + Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html in the *EMR Management Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-kerberosattributes Type: KerberosAttributes UpdateType: Immutable .PARAMETER LogUri + The path to the Amazon S3 location where logs for this cluster are stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-loguri PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-name PrimitiveType: String UpdateType: Immutable .PARAMETER ReleaseLabel + The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version, for example, emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use AmiVersion. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-releaselabel PrimitiveType: String UpdateType: Immutable .PARAMETER ScaleDownBehavior + The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-scaledownbehavior PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityConfiguration + The name of the security configuration applied to the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-securityconfiguration PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceRole + The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-servicerole PrimitiveType: String UpdateType: Immutable .PARAMETER Steps + A list of steps to run. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-steps DuplicatesAllowed: False ItemType: StepConfig @@ -106,6 +140,8 @@ function New-VSEMRCluster { UpdateType: Immutable .PARAMETER Tags + A list of tags associated with a cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-tags DuplicatesAllowed: True ItemType: Tag @@ -113,6 +149,8 @@ function New-VSEMRCluster { UpdateType: Mutable .PARAMETER VisibleToAllUsers + Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-visibletoallusers PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 b/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 index 97fa9a4a4..9f04cb9a4 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 @@ -1,10 +1,14 @@ function New-VSEMRInstanceFleetConfig { <# .SYNOPSIS - Adds an AWS::EMR::InstanceFleetConfig resource to the template. + Adds an AWS::EMR::InstanceFleetConfig resource to the template. Use InstanceFleetConfig to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see Configure Instance Fleets: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. .DESCRIPTION - Adds an AWS::EMR::InstanceFleetConfig resource to the template. + Adds an AWS::EMR::InstanceFleetConfig resource to the template. Use InstanceFleetConfig to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see Configure Instance Fleets: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. + +**Note** + +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html @@ -13,16 +17,23 @@ function New-VSEMRInstanceFleetConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClusterId + The unique identifier of the EMR cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-clusterid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceFleetType + The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancefleettype PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceTypeConfigs + InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet, each one specified using an InstanceTypeConfig. +The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfigs DuplicatesAllowed: False ItemType: InstanceTypeConfig @@ -30,21 +41,31 @@ function New-VSEMRInstanceFleetConfig { UpdateType: Immutable .PARAMETER LaunchSpecifications + The launch specification for the instance fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-launchspecifications Type: InstanceFleetProvisioningSpecifications UpdateType: Immutable .PARAMETER Name + The friendly name of the instance fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-name PrimitiveType: String UpdateType: Immutable .PARAMETER TargetOnDemandCapacity + The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. +If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-targetondemandcapacity PrimitiveType: Integer UpdateType: Mutable .PARAMETER TargetSpotCapacity + The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. +If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-targetspotcapacity PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 b/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 index 388a925c2..da3726a05 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 @@ -1,10 +1,10 @@ function New-VSEMRInstanceGroupConfig { <# .SYNOPSIS - Adds an AWS::EMR::InstanceGroupConfig resource to the template. + Adds an AWS::EMR::InstanceGroupConfig resource to the template. Use InstanceGroupConfig to define instance groups for an EMR cluster. A cluster can not use both instance groups and instance fleets. For more information, see Create a Cluster with Instance Fleets or Uniform Instance Groups: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. .DESCRIPTION - Adds an AWS::EMR::InstanceGroupConfig resource to the template. + Adds an AWS::EMR::InstanceGroupConfig resource to the template. Use InstanceGroupConfig to define instance groups for an EMR cluster. A cluster can not use both instance groups and instance fleets. For more information, see Create a Cluster with Instance Fleets or Uniform Instance Groups: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html in the *Amazon EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html @@ -13,16 +13,24 @@ function New-VSEMRInstanceGroupConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AutoScalingPolicy + AutoScalingPolicy is a subproperty of InstanceGroupConfig. AutoScalingPolicy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. For more information, see Using Automatic Scaling in Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html in the *Amazon EMR Management Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy Type: AutoScalingPolicy UpdateType: Mutable .PARAMETER BidPrice + The maximum Spot price your are willing to pay for EC2 instances. +If BidPrice is specified, Amazon EMR uses Spot Instances for the instance group. Specified in USD. Alternatively, a value of OnDemandPrice indicates that the maximum Spot price is set equal to the On-Demand price. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-bidprice PrimitiveType: String UpdateType: Immutable .PARAMETER Configurations + Amazon EMR releases 4.x or later. +The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group master, core, and task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-configurations DuplicatesAllowed: False ItemType: Configuration @@ -30,36 +38,50 @@ function New-VSEMRInstanceGroupConfig { UpdateType: Immutable .PARAMETER EbsConfiguration + EbsConfiguration determines the EBS volumes to attach to EMR cluster instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-ebsconfiguration Type: EbsConfiguration UpdateType: Immutable .PARAMETER InstanceCount + Target number of instances for the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfiginstancecount- PrimitiveType: Integer UpdateType: Mutable .PARAMETER InstanceRole + The role of the instance group in the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-instancerole PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceType + The EC2 instance type for all instances in the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER JobFlowId + The ID of an Amazon EMR cluster that you want to associate this instance group with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-jobflowid PrimitiveType: String UpdateType: Immutable .PARAMETER Market + Market type of the EC2 instances used to create a cluster node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-market PrimitiveType: String UpdateType: Immutable .PARAMETER Name + Friendly name given to the instance group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 index c19b88f2a..c1526eea2 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 @@ -1,10 +1,10 @@ function New-VSEMRSecurityConfiguration { <# .SYNOPSIS - Adds an AWS::EMR::SecurityConfiguration resource to the template. + Adds an AWS::EMR::SecurityConfiguration resource to the template. Use a SecurityConfiguration resource to configure data encryption, Kerberos authentication (available in Amazon EMR release version 5.10.0 and later, and Amazon S3 authorization for EMRFS (available in EMR 5.10.0 and later. You can re-use a security configuration for any number of clusters in your account. For more information and example security configuration JSON objects, see Create a Security Configuration: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-create-security-configuration.html in the *Amazon EMR Management Guide*. .DESCRIPTION - Adds an AWS::EMR::SecurityConfiguration resource to the template. + Adds an AWS::EMR::SecurityConfiguration resource to the template. Use a SecurityConfiguration resource to configure data encryption, Kerberos authentication (available in Amazon EMR release version 5.10.0 and later, and Amazon S3 authorization for EMRFS (available in EMR 5.10.0 and later. You can re-use a security configuration for any number of clusters in your account. For more information and example security configuration JSON objects, see Create a Security Configuration: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-create-security-configuration.html in the *Amazon EMR Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html @@ -13,11 +13,15 @@ function New-VSEMRSecurityConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name of the security configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html#cfn-emr-securityconfiguration-name PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityConfiguration + The security configuration details in JSON format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html#cfn-emr-securityconfiguration-securityconfiguration PrimitiveType: Json UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 b/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 index b2c07c528..e3e80e8c0 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 @@ -1,10 +1,10 @@ function New-VSEMRStep { <# .SYNOPSIS - Adds an AWS::EMR::Step resource to the template. + Adds an AWS::EMR::Step resource to the template. Use Step to specify a cluster (job flow step, which runs only on the master node. Steps are used to submit data processing jobs to a cluster. .DESCRIPTION - Adds an AWS::EMR::Step resource to the template. + Adds an AWS::EMR::Step resource to the template. Use Step to specify a cluster (job flow step, which runs only on the master node. Steps are used to submit data processing jobs to a cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html @@ -13,21 +13,29 @@ function New-VSEMRStep { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ActionOnFailure + The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-actiononfailure PrimitiveType: String UpdateType: Immutable .PARAMETER HadoopJarStep + The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-hadoopjarstep Type: HadoopJarStepConfig UpdateType: Immutable .PARAMETER JobFlowId + A string that uniquely identifies the cluster job flow. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-jobflowid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the cluster step. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 index b0d06986c..eeb1c9423 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 @@ -1,10 +1,10 @@ function New-VSElastiCacheCacheCluster { <# .SYNOPSIS - Adds an AWS::ElastiCache::CacheCluster resource to the template. + Adds an AWS::ElastiCache::CacheCluster resource to the template. The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster. .DESCRIPTION - Adds an AWS::ElastiCache::CacheCluster resource to the template. + Adds an AWS::ElastiCache::CacheCluster resource to the template. The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html @@ -13,26 +13,64 @@ function New-VSElastiCacheCacheCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AZMode + Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. +This parameter is only supported for Memcached clusters. +If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-azmode PrimitiveType: String UpdateType: Conditional .PARAMETER AutoMinorVersionUpgrade + This parameter is currently disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-autominorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheNodeType + The compute and memory capacity of the nodes in the node group shard. +The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. ++ General purpose: ++ Current generation: +**M5 node types:** cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge +**M4 node types:** cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge +**T2 node types:** cache.t2.micro, cache.t2.small, cache.t2.medium ++ Previous generation: not recommended +**T1 node types:** cache.t1.micro +**M1 node types:** cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge +**M3 node types:** cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge ++ Compute optimized: ++ Previous generation: not recommended +**C1 node types:** cache.c1.xlarge ++ Memory optimized: ++ Current generation: +**R5 node types:** cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge +**R4 node types:** cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge ++ Previous generation: not recommended +**M2 node types:** cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge +**R3 node types:** cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge +**Additional node type info** ++ All current generation instance types are created in Amazon VPC by default. ++ Redis append-only files AOF are not supported for T1 or T2 instances. ++ Redis Multi-AZ with automatic failover is not supported on T1 instances. ++ Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachenodetype PrimitiveType: String UpdateType: Mutable .PARAMETER CacheParameterGroupName + The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cacheparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER CacheSecurityGroupNames + A list of security group names to associate with this cluster. +Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud Amazon VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames DuplicatesAllowed: True PrimitiveItemType: String @@ -40,46 +78,78 @@ function New-VSElastiCacheCacheCluster { UpdateType: Mutable .PARAMETER CacheSubnetGroupName + The name of the subnet group to be used for the cluster. +Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud Amazon VPC. +If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER ClusterName + A name for the cache cluster. If you don't specify a name, AWSCloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +The name must contain 1 to 20 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-clustername PrimitiveType: String UpdateType: Immutable .PARAMETER Engine + The name of the cache engine to be used for this cluster. +Valid values for this parameter are: memcached | redis + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engine PrimitiveType: String UpdateType: Immutable .PARAMETER EngineVersion + The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. +**Important:** You can upgrade to a newer engine version see Selecting a Cache Engine and Version: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engineversion PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationTopicArn + The Amazon Resource Name ARN of the Amazon Simple Notification Service SNS topic to which notifications are sent. +The Amazon SNS topic owner must be the same as the cluster owner. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-notificationtopicarn PrimitiveType: String UpdateType: Mutable .PARAMETER NumCacheNodes + The number of cache nodes that the cache cluster should have. +However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-numcachenodes PrimitiveType: Integer UpdateType: Conditional .PARAMETER Port + The port number on which each of the cache nodes accepts connections. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-port PrimitiveType: Integer UpdateType: Immutable .PARAMETER PreferredAvailabilityZone + The EC2 Availability Zone in which the cluster is created. +All nodes belonging to this Memcached cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. +Default: System chosen Availability Zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone PrimitiveType: String UpdateType: Conditional .PARAMETER PreferredAvailabilityZones + A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. +This option is only supported on Memcached. +If you are creating your cluster in an Amazon VPC recommended you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. +The number of Availability Zones listed must equal the value of NumCacheNodes. +If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. +Default: System chosen Availability Zones. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones DuplicatesAllowed: False PrimitiveItemType: String @@ -87,11 +157,27 @@ function New-VSElastiCacheCacheCluster { UpdateType: Conditional .PARAMETER PreferredMaintenanceWindow + Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi 24H Clock UTC. The minimum maintenance window is a 60 minute period. Valid values for ddd are: +Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi 24H Clock UTC. The minimum maintenance window is a 60 minute period. +Valid values for ddd are: ++ sun ++ mon ++ tue ++ wed ++ thu ++ fri ++ sat +Example: sun:23:00-mon:01:30 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER SnapshotArns + A single-element string list containing an Amazon Resource Name ARN that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group shard. The Amazon S3 object name in the ARN cannot contain any commas. +This parameter is only valid if the Engine parameter is redis. +Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotarns DuplicatesAllowed: False PrimitiveItemType: String @@ -99,21 +185,35 @@ function New-VSElastiCacheCacheCluster { UpdateType: Immutable .PARAMETER SnapshotName + The name of a Redis snapshot from which to restore data into the new node group shard. The snapshot status changes to restoring while the new node group shard is being created. +This parameter is only valid if the Engine parameter is redis. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotname PrimitiveType: String UpdateType: Immutable .PARAMETER SnapshotRetentionLimit + The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted. +This parameter is only valid if the Engine parameter is redis. +Default: 0 i.e., automatic backups are disabled for this cache cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotWindow + The daily time range in UTC during which ElastiCache begins taking a daily snapshot of your node group shard. +Example: 05:00-09:00 +If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. +This parameter is only valid if the Engine parameter is redis. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotwindow PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A list of cost allocation tags to be added to this resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-tags DuplicatesAllowed: True ItemType: Tag @@ -121,6 +221,9 @@ function New-VSElastiCacheCacheCluster { UpdateType: Mutable .PARAMETER VpcSecurityGroupIds + One or more VPC security groups associated with the cluster. +Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud Amazon VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 index 1e7939eb6..9452c7f2e 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 @@ -1,10 +1,14 @@ function New-VSElastiCacheParameterGroup { <# .SYNOPSIS - Adds an AWS::ElastiCache::ParameterGroup resource to the template. + Adds an AWS::ElastiCache::ParameterGroup resource to the template. The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group. Cache parameter groups control the parameters for a cache cluster. .DESCRIPTION - Adds an AWS::ElastiCache::ParameterGroup resource to the template. + Adds an AWS::ElastiCache::ParameterGroup resource to the template. The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group. Cache parameter groups control the parameters for a cache cluster. + +**Note** + +Updates are not supported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html @@ -13,16 +17,30 @@ function New-VSElastiCacheParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CacheParameterGroupFamily + The name of the cache parameter group family that this cache parameter group is compatible with. +Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-cacheparametergroupfamily PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description for this cache parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER Properties + A comma-delimited list of parameter name/value pairs. For more information, see ModifyCacheParameterGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html in the *Amazon ElastiCache API Reference Guide*. +For example: + +"Properties" : { +"cas_disabled" : "1", +"chunk_size_growth_factor" : "1.02" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-properties DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 index 61cbdd3f2..bb191aca1 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 @@ -1,10 +1,10 @@ function New-VSElastiCacheReplicationGroup { <# .SYNOPSIS - Adds an AWS::ElastiCache::ReplicationGroup resource to the template. + Adds an AWS::ElastiCache::ReplicationGroup resource to the template. The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache Redis replication group. A replication group is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas. .DESCRIPTION - Adds an AWS::ElastiCache::ReplicationGroup resource to the template. + Adds an AWS::ElastiCache::ReplicationGroup resource to the template. The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache Redis replication group. A replication group is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html @@ -13,36 +13,91 @@ function New-VSElastiCacheReplicationGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AtRestEncryptionEnabled + A flag that enables encryption at rest when set to true. +You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. +**Required:** Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled PrimitiveType: Boolean UpdateType: Immutable .PARAMETER AuthToken + **Reserved parameter.** The password used to access a password protected server. +AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. +For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. +Password constraints: ++ Must be only printable ASCII characters. ++ Must be at least 16 characters and no more than 128 characters in length. ++ Cannot contain any of the following characters: '/', '"', or '@'. +For more information, see AUTH password: http://redis.io/commands/AUTH at http://redis.io/commands/AUTH. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken PrimitiveType: String UpdateType: Conditional .PARAMETER AutoMinorVersionUpgrade + This parameter is currently disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-autominorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AutomaticFailoverEnabled + Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. +If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. +AutomaticFailoverEnabled must be enabled for Redis cluster mode enabled replication groups. +Default: false +Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: ++ Redis versions earlier than 2.8.6. ++ Redis cluster mode disabled: T1 node types. ++ Redis cluster mode enabled: T1 node types. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-automaticfailoverenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CacheNodeType + The compute and memory capacity of the nodes in the node group shard. +The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. ++ General purpose: ++ Current generation: +**M5 node types:** cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge +**M4 node types:** cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge +**T2 node types:** cache.t2.micro, cache.t2.small, cache.t2.medium ++ Previous generation: not recommended +**T1 node types:** cache.t1.micro +**M1 node types:** cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge +**M3 node types:** cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge ++ Compute optimized: ++ Previous generation: not recommended +**C1 node types:** cache.c1.xlarge ++ Memory optimized: ++ Current generation: +**R5 node types:** cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge +**R4 node types:** cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge ++ Previous generation: not recommended +**M2 node types:** cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge +**R3 node types:** cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachenodetype PrimitiveType: String UpdateType: Mutable .PARAMETER CacheParameterGroupName + The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. +If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0. +If you are running Redis version 3.2.4 or later, only one node group shard, and want to use a default parameter group, we recommend that you specify the parameter group by name. ++ To create a Redis cluster mode disabled replication group, use CacheParameterGroupName=default.redis3.2. ++ To create a Redis cluster mode enabled replication group, use CacheParameterGroupName=default.redis3.2.cluster.on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cacheparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER CacheSecurityGroupNames + A list of cache security group names to associate with this replication group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesecuritygroupnames DuplicatesAllowed: False PrimitiveItemType: String @@ -50,26 +105,38 @@ function New-VSElastiCacheReplicationGroup { UpdateType: Mutable .PARAMETER CacheSubnetGroupName + The name of the cache subnet group to be used for the replication group. +If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER Engine + The name of the cache engine to be used for the clusters in this replication group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engine PrimitiveType: String UpdateType: Immutable .PARAMETER EngineVersion + The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. +**Important:** You can upgrade to a newer engine version see Selecting a Cache Engine and Version: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement in the *ElastiCache User Guide*, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engineversion PrimitiveType: String UpdateType: Mutable .PARAMETER KmsKeyId + The ID of the KMS key used to encrypt the disk on the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER NodeGroupConfiguration + NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache ElastiCache Redis cluster node group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration DuplicatesAllowed: False ItemType: NodeGroupConfiguration @@ -77,26 +144,45 @@ function New-VSElastiCacheReplicationGroup { UpdateType: Conditional .PARAMETER NotificationTopicArn + The Amazon Resource Name ARN of the Amazon Simple Notification Service SNS topic to which notifications are sent. +The Amazon SNS topic owner must be the same as the cluster owner. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-notificationtopicarn PrimitiveType: String UpdateType: Mutable .PARAMETER NumCacheClusters + The number of clusters this replication group initially has. +This parameter is not used if there is more than one node group shard. You should use ReplicasPerNodeGroup instead. +If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter it will default to 1, or you can explicitly set it to a value between 2 and 6. +The maximum permitted value for NumCacheClusters is 6 1 primary plus 5 replicas. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numcacheclusters PrimitiveType: Integer UpdateType: Mutable .PARAMETER NumNodeGroups + An optional parameter that specifies the number of node groups shards for this Redis cluster mode enabled replication group. For Redis cluster mode disabled either omit this parameter or set it to 1. +Default: 1 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups PrimitiveType: Integer UpdateType: Conditional .PARAMETER Port + The port number on which each member of the replication group accepts connections. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-port PrimitiveType: Integer UpdateType: Immutable .PARAMETER PreferredCacheClusterAZs + A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. +This parameter is not used if there is more than one node group shard. You should use NodeGroupConfiguration instead. +If you are creating your replication group in an Amazon VPC recommended, you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. +The number of Availability Zones listed must equal the value of NumCacheClusters. +Default: system chosen Availability Zones. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredcacheclusterazs DuplicatesAllowed: False PrimitiveItemType: String @@ -104,31 +190,59 @@ function New-VSElastiCacheReplicationGroup { UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi 24H Clock UTC. The minimum maintenance window is a 60 minute period. Valid values for ddd are: +Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi 24H Clock UTC. The minimum maintenance window is a 60 minute period. +Valid values for ddd are: ++ sun ++ mon ++ tue ++ wed ++ thu ++ fri ++ sat +Example: sun:23:00-mon:01:30 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER PrimaryClusterId + The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. +This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-primaryclusterid PrimitiveType: String UpdateType: Mutable .PARAMETER ReplicasPerNodeGroup + An optional parameter that specifies the number of replica nodes in each node group shard. Valid values are 0 to 5. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicaspernodegroup PrimitiveType: Integer UpdateType: Immutable .PARAMETER ReplicationGroupDescription + A user-created description for the replication group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER ReplicationGroupId + The replication group identifier. This parameter is stored as a lowercase string. +Constraints: ++ A name must contain from 1 to 40 alphanumeric characters or hyphens. ++ The first character must be a letter. ++ A name cannot end with a hyphen or contain two consecutive hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupid PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroupIds + One or more Amazon VPC security groups associated with this replication group. +Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud Amazon VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-securitygroupids DuplicatesAllowed: False PrimitiveItemType: String @@ -136,6 +250,9 @@ function New-VSElastiCacheReplicationGroup { UpdateType: Mutable .PARAMETER SnapshotArns + A list of Amazon Resource Names ARN that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups console: shards specified by the parameter *NumNodeGroups* or the number of node groups configured by *NodeGroupConfiguration* regardless of the number of ARNs specified here. +Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotarns DuplicatesAllowed: False PrimitiveItemType: String @@ -143,26 +260,39 @@ function New-VSElastiCacheReplicationGroup { UpdateType: Immutable .PARAMETER SnapshotName + The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotname PrimitiveType: String UpdateType: Immutable .PARAMETER SnapshotRetentionLimit + The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. +Default: 0 i.e., automatic backups are disabled for this cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotretentionlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotWindow + The daily time range in UTC during which ElastiCache begins taking a daily snapshot of your node group shard. +Example: 05:00-09:00 +If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotwindow PrimitiveType: String UpdateType: Mutable .PARAMETER SnapshottingClusterId + The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis cluster mode enabled replication groups. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshottingclusterid PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-tags DuplicatesAllowed: True ItemType: Tag @@ -170,6 +300,14 @@ function New-VSElastiCacheReplicationGroup { UpdateType: Mutable .PARAMETER TransitEncryptionEnabled + A flag that enables in-transit encryption when set to true. +You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. +This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6 or 4.x or 5.x, and the cluster is being created in an Amazon VPC. +If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. +**Required:** Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward. +Default: false +For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionenabled PrimitiveType: Boolean UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 index 83d7ad251..e86d9f867 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 @@ -1,10 +1,16 @@ function New-VSElastiCacheSecurityGroup { <# .SYNOPSIS - Adds an AWS::ElastiCache::SecurityGroup resource to the template. + Adds an AWS::ElastiCache::SecurityGroup resource to the template. The AWS::ElastiCache::SecurityGroup resource creates a cache security group. For more information about cache security groups, go to CacheSecurityGroups: https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/VPCs.html in the *Amazon ElastiCache User Guide* or go to CreateCacheSecurityGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSecurityGroup.html in the *Amazon ElastiCache API Reference Guide*. .DESCRIPTION - Adds an AWS::ElastiCache::SecurityGroup resource to the template. + Adds an AWS::ElastiCache::SecurityGroup resource to the template. The AWS::ElastiCache::SecurityGroup resource creates a cache security group. For more information about cache security groups, go to CacheSecurityGroups: https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/VPCs.html in the *Amazon ElastiCache User Guide* or go to CreateCacheSecurityGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSecurityGroup.html in the *Amazon ElastiCache API Reference Guide*. + +For more information, see CreateCacheSubnetGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html. + +**Note** + +Updates are not supported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group.html @@ -13,6 +19,8 @@ function New-VSElastiCacheSecurityGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the cache security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group.html#cfn-elasticache-securitygroup-description PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 index 32b57da20..f502d7911 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 @@ -1,10 +1,14 @@ function New-VSElastiCacheSecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::ElastiCache::SecurityGroupIngress resource to the template. + Adds an AWS::ElastiCache::SecurityGroupIngress resource to the template. The AWS::ElastiCache::SecurityGroupIngress type authorizes ingress to a cache security group from hosts in specified Amazon EC2 security groups. For more information about ElastiCache security group ingress, go to AuthorizeCacheSecurityGroupIngress: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_AuthorizeCacheSecurityGroupIngress.html in the *Amazon ElastiCache API Reference Guide*. .DESCRIPTION - Adds an AWS::ElastiCache::SecurityGroupIngress resource to the template. + Adds an AWS::ElastiCache::SecurityGroupIngress resource to the template. The AWS::ElastiCache::SecurityGroupIngress type authorizes ingress to a cache security group from hosts in specified Amazon EC2 security groups. For more information about ElastiCache security group ingress, go to AuthorizeCacheSecurityGroupIngress: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_AuthorizeCacheSecurityGroupIngress.html in the *Amazon ElastiCache API Reference Guide*. + +**Note** + +Updates are not supported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html @@ -13,16 +17,22 @@ function New-VSElastiCacheSecurityGroupIngress { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CacheSecurityGroupName + The name of the Cache Security Group to authorize. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-cachesecuritygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupName + Name of the EC2 Security Group to include in the authorization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupOwnerId + Specifies the AWS Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property. The AWS access key ID is not an acceptable value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupownerid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 index fe5d622d3..c5a8a2dfa 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSElastiCacheSubnetGroup { <# .SYNOPSIS - Adds an AWS::ElastiCache::SubnetGroup resource to the template. + Adds an AWS::ElastiCache::SubnetGroup resource to the template. Creates a cache subnet group. For more information about cache subnet groups, go to Cache Subnet Groups in the *Amazon ElastiCache User Guide* or go to CreateCacheSubnetGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html in the *Amazon ElastiCache API Reference Guide*. .DESCRIPTION - Adds an AWS::ElastiCache::SubnetGroup resource to the template. + Adds an AWS::ElastiCache::SubnetGroup resource to the template. Creates a cache subnet group. For more information about cache subnet groups, go to Cache Subnet Groups in the *Amazon ElastiCache User Guide* or go to CreateCacheSubnetGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html in the *Amazon ElastiCache API Reference Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html @@ -13,16 +13,24 @@ function New-VSElastiCacheSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CacheSubnetGroupName + The name for the cache subnet group. This value is stored as a lowercase string. +Constraints: Must contain no more than 255 alphanumeric characters or hyphens. +Example: mysubnetgroup + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-cachesubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description for the cache subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds + The EC2 subnet IDs for the cache subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-subnetids DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 index a46f92fa6..e45a6c1e0 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 @@ -1,10 +1,10 @@ function New-VSElasticBeanstalkApplication { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Application resource to the template. + Adds an AWS::ElasticBeanstalk::Application resource to the template. The AWS::ElasticBeanstalk::Application resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk application. .DESCRIPTION - Adds an AWS::ElasticBeanstalk::Application resource to the template. + Adds an AWS::ElasticBeanstalk::Application resource to the template. The AWS::ElasticBeanstalk::Application resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html @@ -13,16 +13,23 @@ function New-VSElasticBeanstalkApplication { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html#cfn-elasticbeanstalk-application-name PrimitiveType: String UpdateType: Immutable .PARAMETER Description + Your description of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html#cfn-elasticbeanstalk-application-description PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceLifecycleConfig + Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html#cfn-elasticbeanstalk-application-resourcelifecycleconfig Type: ApplicationResourceLifecycleConfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 index c743b22e9..188abedbf 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 @@ -1,10 +1,14 @@ function New-VSElasticBeanstalkApplicationVersion { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::ApplicationVersion resource to the template. + Adds an AWS::ElasticBeanstalk::ApplicationVersion resource to the template. The AWS::ElasticBeanstalk::ApplicationVersion resource is an AWS Elastic Beanstalk resource type that specifies an application version, an iteration of deployable code, for an Elastic Beanstalk application. .DESCRIPTION - Adds an AWS::ElasticBeanstalk::ApplicationVersion resource to the template. + Adds an AWS::ElasticBeanstalk::ApplicationVersion resource to the template. The AWS::ElasticBeanstalk::ApplicationVersion resource is an AWS Elastic Beanstalk resource type that specifies an application version, an iteration of deployable code, for an Elastic Beanstalk application. + +**Note** + +After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, an attempt to launch an environment from the application version will fail. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html @@ -13,16 +17,23 @@ function New-VSElasticBeanstalkApplicationVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the Elastic Beanstalk application that is associated with this application version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html#cfn-elasticbeanstalk-applicationversion-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A description of this application version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html#cfn-elasticbeanstalk-applicationversion-description PrimitiveType: String UpdateType: Mutable .PARAMETER SourceBundle + The Amazon S3 bucket and key that identify the location of the source bundle for this version. +The Amazon S3 bucket must be in the same region as the environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html#cfn-elasticbeanstalk-applicationversion-sourcebundle Type: SourceBundle UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 index ba81f7a33..a6ec87a9a 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSElasticBeanstalkConfigurationTemplate { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::ConfigurationTemplate resource to the template. + Adds an AWS::ElasticBeanstalk::ConfigurationTemplate resource to the template. The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. .DESCRIPTION - Adds an AWS::ElasticBeanstalk::ConfigurationTemplate resource to the template. + Adds an AWS::ElasticBeanstalk::ConfigurationTemplate resource to the template. The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html @@ -13,21 +13,29 @@ function New-VSElasticBeanstalkConfigurationTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the Elastic Beanstalk application to associate with this configuration template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Description + An optional description for this configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-description PrimitiveType: String UpdateType: Mutable .PARAMETER EnvironmentId + The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-environmentid PrimitiveType: String UpdateType: Immutable .PARAMETER OptionSettings + Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html in the *AWS Elastic Beanstalk Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-optionsettings DuplicatesAllowed: True ItemType: ConfigurationOptionSetting @@ -35,16 +43,28 @@ function New-VSElasticBeanstalkConfigurationTemplate { UpdateType: Mutable .PARAMETER PlatformArn + The Amazon Resource Name ARN of the custom platform. For more information, see Custom Platforms: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html in the *AWS Elastic Beanstalk Developer Guide*. +If you specify PlatformArn, then don't specify SolutionStackName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-platformarn PrimitiveType: String UpdateType: Immutable .PARAMETER SolutionStackName + The name of an Elastic Beanstalk solution stack platform version that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html in the *AWS Elastic Beanstalk Developer Guide*. +You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. +Use the ListAvailableSolutionStacks : https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html API to obtain a list of available solution stacks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-solutionstackname PrimitiveType: String UpdateType: Immutable .PARAMETER SourceConfiguration + An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. +Values specified in OptionSettings override any values obtained from the SourceConfiguration. +You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName. +Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration Type: SourceConfiguration UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 index 9c07975d3..76a7a41ee 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 @@ -1,10 +1,10 @@ function New-VSElasticBeanstalkEnvironment { <# .SYNOPSIS - Adds an AWS::ElasticBeanstalk::Environment resource to the template. + Adds an AWS::ElasticBeanstalk::Environment resource to the template. The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment. .DESCRIPTION - Adds an AWS::ElasticBeanstalk::Environment resource to the template. + Adds an AWS::ElasticBeanstalk::Environment resource to the template. The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html @@ -13,26 +13,40 @@ function New-VSElasticBeanstalkEnvironment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the application that is associated with this environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER CNAMEPrefix + If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-cnameprefix PrimitiveType: String UpdateType: Immutable .PARAMETER Description + Your description for this environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-description PrimitiveType: String UpdateType: Mutable .PARAMETER EnvironmentName + A unique name for the environment. +Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. +If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application. +If you don't specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-name PrimitiveType: String UpdateType: Immutable .PARAMETER OptionSettings + Key-value pairs defining configuration options for this environment, such as the instance type. These options override the values that are defined in the solution stack or the configuration template: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html. If you remove any options during a stack update, the removed options retain their current values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-optionsettings DuplicatesAllowed: True ItemType: OptionSetting @@ -40,16 +54,24 @@ function New-VSElasticBeanstalkEnvironment { UpdateType: Mutable .PARAMETER PlatformArn + The Amazon Resource Name ARN of the custom platform to use with the environment. For more information, see Custom Platforms: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html in the *AWS Elastic Beanstalk Developer Guide*. +If you specify PlatformArn, don't specify SolutionStackName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn PrimitiveType: String UpdateType: Mutable .PARAMETER SolutionStackName + The name of an Elastic Beanstalk solution stack platform version to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html in the *AWS Elastic Beanstalk Platforms* guide. +If you specify SolutionStackName, don't specify PlatformArn or TemplateName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-solutionstackname PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Specifies the tags applied to resources in the environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-elasticbeanstalk-environment-tags DuplicatesAllowed: True ItemType: Tag @@ -57,16 +79,24 @@ function New-VSElasticBeanstalkEnvironment { UpdateType: Mutable .PARAMETER TemplateName + The name of the Elastic Beanstalk configuration template to use with the environment. +If you specify TemplateName, then don't specify SolutionStackName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-templatename PrimitiveType: String UpdateType: Mutable .PARAMETER Tier + Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTPS requests or a web application that handles background-processing tasks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-tier Type: Tier UpdateType: Conditional .PARAMETER VersionLabel + The name of the application version to deploy. +Default: If not specified, Elastic Beanstalk attempts to deploy the sample application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-versionlabel PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 index 2b12e681d..907c25479 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 @@ -1,10 +1,14 @@ function New-VSElasticLoadBalancingLoadBalancer { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancing::LoadBalancer resource to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer resource to the template. Specifies a Classic Load Balancer. .DESCRIPTION - Adds an AWS::ElasticLoadBalancing::LoadBalancer resource to the template. + Adds an AWS::ElasticLoadBalancing::LoadBalancer resource to the template. Specifies a Classic Load Balancer. + +You can specify the AvailabilityZones or Subnets property, but not both. + +If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html to declare a dependency on the VPC-gateway attachment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html @@ -13,11 +17,15 @@ function New-VSElasticLoadBalancingLoadBalancer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccessLoggingPolicy + Information about where and how access logs are stored for the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-accessloggingpolicy Type: AccessLoggingPolicy UpdateType: Mutable .PARAMETER AppCookieStickinessPolicy + Information about a policy for application-controlled session stickiness. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-appcookiestickinesspolicy DuplicatesAllowed: False ItemType: AppCookieStickinessPolicy @@ -25,6 +33,9 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Mutable .PARAMETER AvailabilityZones + The Availability Zones for the load balancer. For load balancers in a VPC, specify Subnets instead. +Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-availabilityzones DuplicatesAllowed: False PrimitiveItemType: String @@ -32,26 +43,40 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Conditional .PARAMETER ConnectionDrainingPolicy + If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance. +For more information, see Configure Connection Draining: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html in the *Classic Load Balancers Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-connectiondrainingpolicy Type: ConnectionDrainingPolicy UpdateType: Mutable .PARAMETER ConnectionSettings + If enabled, the load balancer allows the connections to remain idle no data is sent over the connection for the specified duration. +By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html in the *Classic Load Balancers Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-connectionsettings Type: ConnectionSettings UpdateType: Mutable .PARAMETER CrossZone + If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones. +For more information, see Configure Cross-Zone Load Balancing: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html in the *Classic Load Balancers Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-crosszone PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HealthCheck + The health check settings to use when evaluating the health of your EC2 instances. +Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-healthcheck Type: HealthCheck UpdateType: Conditional .PARAMETER Instances + The IDs of the instances for the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-instances DuplicatesAllowed: False PrimitiveItemType: String @@ -59,6 +84,8 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Mutable .PARAMETER LBCookieStickinessPolicy + Information about a policy for duration-based session stickiness. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-lbcookiestickinesspolicy DuplicatesAllowed: False ItemType: LBCookieStickinessPolicy @@ -66,6 +93,9 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Mutable .PARAMETER Listeners + The listeners for the load balancer. You can specify at most one listener per port. +If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-listeners DuplicatesAllowed: False ItemType: Listeners @@ -73,11 +103,16 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Mutable .PARAMETER LoadBalancerName + The name of the load balancer. This name must be unique within your set of load balancers for the region. +If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-elbname PrimitiveType: String UpdateType: Immutable .PARAMETER Policies + The policies defined for your Classic Load Balancer. Specify only back-end server policies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-policies DuplicatesAllowed: False ItemType: Policies @@ -85,11 +120,17 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Mutable .PARAMETER Scheme + The type of load balancer. Valid only for load balancers in a VPC. +If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address. +If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-scheme PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroups + The security groups for the load balancer. Valid only for load balancers in a VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-securitygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -97,6 +138,9 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Mutable .PARAMETER Subnets + The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone. +Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-subnets DuplicatesAllowed: False PrimitiveItemType: String @@ -104,6 +148,8 @@ function New-VSElasticLoadBalancingLoadBalancer { UpdateType: Conditional .PARAMETER Tags + The tags associated with a load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-elasticloadbalancing-loadbalancer-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 index 5a9384370..62b255a49 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 @@ -1,10 +1,10 @@ function New-VSElasticLoadBalancingV2Listener { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener resource to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener resource to the template. Specifies a listener for an Application Load Balancer or Network Load Balancer. .DESCRIPTION - Adds an AWS::ElasticLoadBalancingV2::Listener resource to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener resource to the template. Specifies a listener for an Application Load Balancer or Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html @@ -13,6 +13,8 @@ function New-VSElasticLoadBalancingV2Listener { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Certificates + The default SSL server certificate. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates DuplicatesAllowed: False ItemType: Certificate @@ -20,6 +22,8 @@ function New-VSElasticLoadBalancingV2Listener { UpdateType: Mutable .PARAMETER DefaultActions + The actions for the default rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions DuplicatesAllowed: False ItemType: Action @@ -27,21 +31,29 @@ function New-VSElasticLoadBalancingV2Listener { UpdateType: Mutable .PARAMETER LoadBalancerArn + The Amazon Resource Name ARN of the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn PrimitiveType: String UpdateType: Immutable .PARAMETER Port + The port on which the load balancer is listening. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER Protocol + The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER SslPolicy + HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 index 7d8008afb..170d50e96 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 @@ -1,10 +1,10 @@ function New-VSElasticLoadBalancingV2ListenerCertificate { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate resource to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate resource to the template. Specifies a certificate list for an HTTPS listener. .DESCRIPTION - Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate resource to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate resource to the template. Specifies a certificate list for an HTTPS listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html @@ -13,6 +13,8 @@ function New-VSElasticLoadBalancingV2ListenerCertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Certificates + The certificates to add. Duplicates are not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-certificates DuplicatesAllowed: False ItemType: Certificate @@ -20,6 +22,8 @@ function New-VSElasticLoadBalancingV2ListenerCertificate { UpdateType: Immutable .PARAMETER ListenerArn + The Amazon Resource Name ARN of the listener. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-listenerarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 index 129c4d790..90eafce05 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 @@ -1,10 +1,10 @@ function New-VSElasticLoadBalancingV2ListenerRule { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule resource to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule resource to the template. Specifies a listener rule. .DESCRIPTION - Adds an AWS::ElasticLoadBalancingV2::ListenerRule resource to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule resource to the template. Specifies a listener rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html @@ -13,6 +13,8 @@ function New-VSElasticLoadBalancingV2ListenerRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Actions + The actions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-actions DuplicatesAllowed: False ItemType: Action @@ -20,6 +22,8 @@ function New-VSElasticLoadBalancingV2ListenerRule { UpdateType: Mutable .PARAMETER Conditions + The conditions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-conditions DuplicatesAllowed: False ItemType: RuleCondition @@ -27,11 +31,15 @@ function New-VSElasticLoadBalancingV2ListenerRule { UpdateType: Mutable .PARAMETER ListenerArn + The Amazon Resource Name ARN of the listener. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-listenerarn PrimitiveType: String UpdateType: Immutable .PARAMETER Priority + The rule priority. A listener can't have multiple rules with the same priority. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-priority PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 index 9b8bb1c98..964dc814f 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 @@ -1,10 +1,10 @@ function New-VSElasticLoadBalancingV2LoadBalancer { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::LoadBalancer resource to the template. + Adds an AWS::ElasticLoadBalancingV2::LoadBalancer resource to the template. Specifies an Application Load Balancer or a Network Load Balancer. .DESCRIPTION - Adds an AWS::ElasticLoadBalancingV2::LoadBalancer resource to the template. + Adds an AWS::ElasticLoadBalancingV2::LoadBalancer resource to the template. Specifies an Application Load Balancer or a Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html @@ -13,11 +13,15 @@ function New-VSElasticLoadBalancingV2LoadBalancer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER IpAddressType + The IP address type. The possible values are ipv4 for IPv4 addresses and dualstack for IPv4 and IPv6 addresses. Internal load balancers must use ipv4. Network Load Balancers must use ipv4. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipaddresstype PrimitiveType: String UpdateType: Mutable .PARAMETER LoadBalancerAttributes + The load balancer attributes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes DuplicatesAllowed: False ItemType: LoadBalancerAttribute @@ -25,16 +29,25 @@ function New-VSElasticLoadBalancingV2LoadBalancer { UpdateType: Mutable .PARAMETER Name + The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". +If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-name PrimitiveType: String UpdateType: Immutable .PARAMETER Scheme + The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. +The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer. +The default is an Internet-facing load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroups + Application Load Balancers] The IDs of the security groups for the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-securitygroups DuplicatesAllowed: False PrimitiveItemType: String @@ -42,6 +55,10 @@ function New-VSElasticLoadBalancingV2LoadBalancer { UpdateType: Mutable .PARAMETER SubnetMappings + The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. +Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. +Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings DuplicatesAllowed: False ItemType: SubnetMapping @@ -49,6 +66,10 @@ function New-VSElasticLoadBalancingV2LoadBalancer { UpdateType: Immutable .PARAMETER Subnets + The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. +Application Load Balancers] You must specify subnets from at least two Availability Zones. When you specify subnets for an existing Application Load Balancer, they replace the previously enabled subnets. +Network Load Balancers] You can specify subnets from one or more Availability Zones when you create the load balancer. You can't change the subnets for an existing Network Load Balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnets DuplicatesAllowed: False PrimitiveItemType: String @@ -56,6 +77,8 @@ function New-VSElasticLoadBalancingV2LoadBalancer { UpdateType: Mutable .PARAMETER Tags + The tags. Each resource can have a maximum of 10 tags. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags DuplicatesAllowed: True ItemType: Tag @@ -63,6 +86,8 @@ function New-VSElasticLoadBalancingV2LoadBalancer { UpdateType: Mutable .PARAMETER Type + The type of load balancer. The default is application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 index d20672f6d..4a5064f13 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 @@ -1,10 +1,12 @@ function New-VSElasticLoadBalancingV2TargetGroup { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::TargetGroup resource to the template. + Adds an AWS::ElasticLoadBalancingV2::TargetGroup resource to the template. Specifies a target group for an Application Load Balancer or Network Load Balancer. .DESCRIPTION - Adds an AWS::ElasticLoadBalancingV2::TargetGroup resource to the template. + Adds an AWS::ElasticLoadBalancingV2::TargetGroup resource to the template. Specifies a target group for an Application Load Balancer or Network Load Balancer. + +Before you register a Lambda function as a target, you must create a AWS::Lambda::Permission resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html @@ -13,61 +15,86 @@ function New-VSElasticLoadBalancingV2TargetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER HealthCheckEnabled + Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HealthCheckIntervalSeconds + The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER HealthCheckPath + HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckPort + The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckProtocol + The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckTimeoutSeconds + The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER HealthyThresholdCount + The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER Matcher + HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher Type: Matcher UpdateType: Mutable .PARAMETER Name + The name of the target group. +This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name PrimitiveType: String UpdateType: Immutable .PARAMETER Port + The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port PrimitiveType: Integer UpdateType: Immutable .PARAMETER Protocol + The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. If the target is a Lambda function, this parameter does not apply. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags. Each resource can have a maximum of 10 tags. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags DuplicatesAllowed: True ItemType: Tag @@ -75,6 +102,8 @@ function New-VSElasticLoadBalancingV2TargetGroup { UpdateType: Mutable .PARAMETER TargetGroupAttributes + The attributes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes DuplicatesAllowed: False ItemType: TargetGroupAttribute @@ -82,11 +111,18 @@ function New-VSElasticLoadBalancingV2TargetGroup { UpdateType: Mutable .PARAMETER TargetType + The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. ++ instance - Targets are specified by instance ID. This is the default value. ++ ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud VPC for the target group, the RFC 1918 range 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16, and the RFC 6598 range 100.64.0.0/10. You can't specify publicly routable IP addresses. ++ lambda - The target groups contains a single Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype PrimitiveType: String UpdateType: Immutable .PARAMETER Targets + The targets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets DuplicatesAllowed: False ItemType: TargetDescription @@ -94,11 +130,15 @@ function New-VSElasticLoadBalancingV2TargetGroup { UpdateType: Mutable .PARAMETER UnhealthyThresholdCount + The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER VpcId + The identifier of the virtual private cloud VPC. If the target is a Lambda function, this parameter does not apply. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 b/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 index 63c07022f..bed4e7a40 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 @@ -1,10 +1,10 @@ function New-VSElasticsearchDomain { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain resource to the template. + Adds an AWS::Elasticsearch::Domain resource to the template. The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service (Amazon ES domain that encapsulates the Amazon ES engine instances. .DESCRIPTION - Adds an AWS::Elasticsearch::Domain resource to the template. + Adds an AWS::Elasticsearch::Domain resource to the template. The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service (Amazon ES domain that encapsulates the Amazon ES engine instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html @@ -13,11 +13,15 @@ function New-VSElasticsearchDomain { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccessPolicies + An AWS Identity and Access Management IAM policy document that specifies who can access the Amazon ES domain and their permissions. For more information, see Configuring Access Policies : https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policiesin the *Amazon Elasticsearch Service Developer Guid*e. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies PrimitiveType: Json UpdateType: Mutable .PARAMETER AdvancedOptions + Additional options to specify for the Amazon ES domain. For more information, see Configuring Advanced Options: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions DuplicatesAllowed: False PrimitiveItemType: String @@ -30,26 +34,37 @@ function New-VSElasticsearchDomain { UpdateType: Mutable .PARAMETER DomainName + A name for the Amazon ES domain. For valid values, see the DomainName: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-domainname data type in the *Amazon Elasticsearch Service Developer Guide*. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER EBSOptions + The configurations of Amazon Elastic Block Store Amazon EBS volumes that are attached to data nodes in the Amazon ES domain. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions Type: EBSOptions UpdateType: Mutable .PARAMETER ElasticsearchClusterConfig + ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon Elasticsearch Service Amazon ES domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig Type: ElasticsearchClusterConfig UpdateType: Mutable .PARAMETER ElasticsearchVersion + The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that Amazon ES supports, see the Elasticsearch-Version parameter for the CreateElasticsearchDomain: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-actions-createelasticsearchdomain action in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion PrimitiveType: String UpdateType: Conditional .PARAMETER EncryptionAtRestOptions + Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service KMS key to use. Can only be used to create a new domain, not update an existing one. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions Type: EncryptionAtRestOptions UpdateType: Immutable @@ -62,16 +77,22 @@ function New-VSElasticsearchDomain { UpdateType: Mutable .PARAMETER NodeToNodeEncryptionOptions + Specifies whether node-to-node encryption is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions Type: NodeToNodeEncryptionOptions UpdateType: Immutable .PARAMETER SnapshotOptions + The automated snapshot configuration for the Amazon ES domain indices. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions Type: SnapshotOptions UpdateType: Mutable .PARAMETER Tags + An arbitrary set of tags key–value pairs to associate with the Amazon ES domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags DuplicatesAllowed: True ItemType: Tag @@ -79,6 +100,8 @@ function New-VSElasticsearchDomain { UpdateType: Mutable .PARAMETER VPCOptions + The virtual private cloud VPC configuration for the Amazon ES domain. For more information, see VPC Support for Amazon Elasticsearch Service Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html in the *Amazon Elasticsearch Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions Type: VPCOptions UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 index c3fac7b2b..62a361a06 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 @@ -1,10 +1,14 @@ function New-VSEventsEventBusPolicy { <# .SYNOPSIS - Adds an AWS::Events::EventBusPolicy resource to the template. + Adds an AWS::Events::EventBusPolicy resource to the template. The AWS::Events::EventBusPolicy resource creates an event bus policy for Amazon CloudWatch Events. An event bus policy enables your account to receive events from other AWS accounts. These events can trigger CloudWatch Events rules created in your account. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEvents-CrossAccountEventDelivery.html in the *Amazon CloudWatch Events User Guide*. .DESCRIPTION - Adds an AWS::Events::EventBusPolicy resource to the template. + Adds an AWS::Events::EventBusPolicy resource to the template. The AWS::Events::EventBusPolicy resource creates an event bus policy for Amazon CloudWatch Events. An event bus policy enables your account to receive events from other AWS accounts. These events can trigger CloudWatch Events rules created in your account. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEvents-CrossAccountEventDelivery.html in the *Amazon CloudWatch Events User Guide*. + +If you grant permissions using Condition and specifying an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. + +The permission policy on the default event bus can't exceed 10 KB in size. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html @@ -18,21 +22,32 @@ function New-VSEventsEventBusPolicy { UpdateType: Immutable .PARAMETER Condition + Condition is a JSON string that you can use to limit the event bus permissions that you're granting only to accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations?: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html in the *AWS Organizations User Guide*. +Condition is a property of the AWS::Events::EventBusPolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html resource type. +If you specify Condition with an AWS organization ID and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization. + Type: Condition Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition UpdateType: Mutable .PARAMETER Action + The action that you are enabling the other account to perform. Currently, this must be events:PutEvents. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action PrimitiveType: String UpdateType: Mutable .PARAMETER StatementId + An identifier string for the external account that you're granting permissions to. If you later want to revoke the permission for this external account, you must specify this StatementId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid PrimitiveType: String UpdateType: Immutable .PARAMETER Principal + The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus. +If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 b/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 index e58a7c053..e9159739a 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 @@ -1,10 +1,14 @@ function New-VSEventsRule { <# .SYNOPSIS - Adds an AWS::Events::Rule resource to the template. + Adds an AWS::Events::Rule resource to the template. The AWS::Events::Rule resource creates a rule that matches incoming events and routes them to one or more targets for processing. For more information, see What Is Amazon CloudWatch Events?: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html. .DESCRIPTION - Adds an AWS::Events::Rule resource to the template. + Adds an AWS::Events::Rule resource to the template. The AWS::Events::Rule resource creates a rule that matches incoming events and routes them to one or more targets for processing. For more information, see What Is Amazon CloudWatch Events?: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html. + +A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPattern are triggered when a matching event is observed. Rules with ScheduleExpression self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. + +Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs. However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html @@ -13,6 +17,8 @@ function New-VSEventsRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description PrimitiveType: String UpdateType: Mutable @@ -23,31 +29,45 @@ function New-VSEventsRule { UpdateType: Immutable .PARAMETER EventPattern + Describes which events CloudWatch Events routes to the specified target. For more information, see Event Patterns in CloudWatch Events: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html in the *Amazon CloudWatch Events User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. +If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the role that is used for target invocation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduleExpression + The scheduling expression that determines when and how often the rule runs. For more information, see Schedule Expressions for Rules: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression PrimitiveType: String UpdateType: Mutable .PARAMETER State + Indicates whether the rule is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state PrimitiveType: String UpdateType: Mutable .PARAMETER Targets + The resources that CloudWatch Events routes events to and invokes when the rule is triggered. For information about valid targets, see PutTargets: https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutTargets.html. +If you're setting the event bus of another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEvents-CrossAccountEventDelivery.html in the *Amazon CloudWatch Events User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets DuplicatesAllowed: False ItemType: Target diff --git a/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 b/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 index bd8aa1fd4..35c3b1d2e 100644 --- a/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 @@ -1,10 +1,10 @@ function New-VSFSxFileSystem { <# .SYNOPSIS - Adds an AWS::FSx::FileSystem resource to the template. + Adds an AWS::FSx::FileSystem resource to the template. The AWS::FSx::FileSystem resource is an Amazon FSx resource type that creates either an Amazon FSx for Windows File Server file system or an Amazon FSx for Lustre file system. .DESCRIPTION - Adds an AWS::FSx::FileSystem resource to the template. + Adds an AWS::FSx::FileSystem resource to the template. The AWS::FSx::FileSystem resource is an Amazon FSx resource type that creates either an Amazon FSx for Windows File Server file system or an Amazon FSx for Lustre file system. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html @@ -13,49 +13,70 @@ function New-VSFSxFileSystem { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KmsKeyId + The ID of the AWS Key Management Service AWS KMS key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER StorageCapacity + The storage capacity of the file system. +For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB. +For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagecapacity PrimitiveType: Integer UpdateType: Immutable .PARAMETER FileSystemType + Type of file system. Currently the only supported type is WINDOWS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtype PrimitiveType: String UpdateType: Immutable .PARAMETER LustreConfiguration + The configuration object for Lustre file systems used in the CreateFileSystem operation. + Type: LustreConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-lustreconfiguration UpdateType: Mutable .PARAMETER BackupId + The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-backupid PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetIds + The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-subnetids UpdateType: Immutable .PARAMETER SecurityGroupIds + A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. This list isn't returned in later describe requests. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-securitygroupids UpdateType: Immutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-tags ItemType: Tag UpdateType: Mutable .PARAMETER WindowsConfiguration + The configuration object for the Microsoft Windows file system you are creating. + Type: WindowsConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 index efecb6b67..74d5a9c97 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftAlias { <# .SYNOPSIS - Adds an AWS::GameLift::Alias resource to the template. + Adds an AWS::GameLift::Alias resource to the template. The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift fleet, which you can use to anonymize your fleet. You can reference the alias instead of a specific fleet when you create game sessions. For more information, see the CreateAlias: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateAlias.html action in the *Amazon GameLift API Reference*. .DESCRIPTION - Adds an AWS::GameLift::Alias resource to the template. + Adds an AWS::GameLift::Alias resource to the template. The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift fleet, which you can use to anonymize your fleet. You can reference the alias instead of a specific fleet when you create game sessions. For more information, see the CreateAlias: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateAlias.html action in the *Amazon GameLift API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html @@ -13,16 +13,22 @@ function New-VSGameLiftAlias { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Human-readable description of an alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description PrimitiveType: String UpdateType: Mutable .PARAMETER Name + Descriptive label that is associated with an alias. Alias names do not need to be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name PrimitiveType: String UpdateType: Mutable .PARAMETER RoutingStrategy + A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-routingstrategy Type: RoutingStrategy UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 index 95121773c..97cc08a34 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftBuild { <# .SYNOPSIS - Adds an AWS::GameLift::Build resource to the template. + Adds an AWS::GameLift::Build resource to the template. The AWS::GameLift::Build resource creates a build that includes all of the components to run your game server in an Amazon GameLift (GameLift fleet. .DESCRIPTION - Adds an AWS::GameLift::Build resource to the template. + Adds an AWS::GameLift::Build resource to the template. The AWS::GameLift::Build resource creates a build that includes all of the components to run your game server in an Amazon GameLift (GameLift fleet. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html @@ -13,21 +13,29 @@ function New-VSGameLiftBuild { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + Descriptive label that is associated with a build. Build names do not need to be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name PrimitiveType: String UpdateType: Mutable .PARAMETER OperatingSystem + + CreateBuild: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem PrimitiveType: String UpdateType: Immutable .PARAMETER StorageLocation + Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a the ARN for a role that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation Type: S3Location UpdateType: Immutable .PARAMETER Version + Version that is associated with this build. Version strings do not need to be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 index a93db9bfe..ddc732350 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftFleet { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet resource to the template. + Adds an AWS::GameLift::Fleet resource to the template. The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift fleet to host game servers. A fleet is a set of EC2 instances, each of which is a host in the fleet. For more information, see the CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html action in the *Amazon GameLift API Reference*. .DESCRIPTION - Adds an AWS::GameLift::Fleet resource to the template. + Adds an AWS::GameLift::Fleet resource to the template. The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift fleet to host game servers. A fleet is a set of EC2 instances, each of which is a host in the fleet. For more information, see the CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html action in the *Amazon GameLift API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html @@ -13,26 +13,36 @@ function New-VSGameLiftFleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BuildId + Unique identifier for a build to be deployed on the new fleet. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateConfiguration + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration Type: CertificateConfiguration UpdateType: Immutable .PARAMETER Description + Human-readable description of a fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description PrimitiveType: String UpdateType: Mutable .PARAMETER DesiredEC2Instances + Number of EC2 instances you want this fleet to host. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances PrimitiveType: Integer UpdateType: Mutable .PARAMETER EC2InboundPermissions + Range of IP addresses and port settings that permit inbound traffic to access game sessions that running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions DuplicatesAllowed: False ItemType: IpPermission @@ -40,21 +50,29 @@ function New-VSGameLiftFleet { UpdateType: Mutable .PARAMETER EC2InstanceType + Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. For more information about the instance types that are supported by GameLift, see the EC2InstanceType: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html#gamelift-CreateFleet-request-EC2InstanceType parameter in the *Amazon GameLift API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER FleetType + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceRoleARN + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn PrimitiveType: String UpdateType: Immutable .PARAMETER LogPaths + This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady and specify one or more directory paths in logParameters. See more information in the Server API Reference: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths DuplicatesAllowed: False PrimitiveItemType: String @@ -62,11 +80,15 @@ function New-VSGameLiftFleet { UpdateType: Immutable .PARAMETER MaxSize + Maximum value allowed for the fleet's instance count. Default if not set is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER MetricGroups + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups DuplicatesAllowed: False PrimitiveItemType: String @@ -74,51 +96,71 @@ function New-VSGameLiftFleet { UpdateType: Mutable .PARAMETER MinSize + Minimum value allowed for the fleet's instance count. Default if not set is 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + Descriptive label that is associated with a fleet. Fleet names do not need to be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name PrimitiveType: String UpdateType: Mutable .PARAMETER NewGameSessionProtectionPolicy + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER PeerVpcAwsAccountId + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid PrimitiveType: String UpdateType: Immutable .PARAMETER PeerVpcId + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceCreationLimitPolicy + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy Type: ResourceCreationLimitPolicy UpdateType: Mutable .PARAMETER RuntimeConfiguration + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration Type: RuntimeConfiguration UpdateType: Mutable .PARAMETER ScriptId + + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid PrimitiveType: String UpdateType: Immutable .PARAMETER ServerLaunchParameters + The parameters that are required to launch your game server. Specify these parameters as a string of command-line parameters, such as +sv_port 33435 +start_lobby. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters PrimitiveType: String UpdateType: Immutable .PARAMETER ServerLaunchPath + The location of your game server that GameLift launches. You must escape the slashes and use the following pattern: C:gamelaunchpath. For example, if your game server files are in the MyGame folder, the path should be C:gameMyGameserver.exe. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 b/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 index a5967b4ce..46980a352 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 @@ -1,10 +1,10 @@ function New-VSGlueClassifier { <# .SYNOPSIS - Adds an AWS::Glue::Classifier resource to the template. + Adds an AWS::Glue::Classifier resource to the template. The AWS::Glue::Classifier resource creates an AWS Glue classifier that categorizes data sources and specifies schemas. For more information, see Adding Classifiers to a Crawler: https://docs.aws.amazon.com/glue/latest/dg/add-classifier.html and Classifier Structure: https://docs.aws.amazon.com/glue/latest/aws-glue-api-crawler-classifiers.html#aws-glue-api-crawler-classifiers-Classifier in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Classifier resource to the template. + Adds an AWS::Glue::Classifier resource to the template. The AWS::Glue::Classifier resource creates an AWS Glue classifier that categorizes data sources and specifies schemas. For more information, see Adding Classifiers to a Crawler: https://docs.aws.amazon.com/glue/latest/dg/add-classifier.html and Classifier Structure: https://docs.aws.amazon.com/glue/latest/aws-glue-api-crawler-classifiers.html#aws-glue-api-crawler-classifiers-Classifier in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html @@ -13,21 +13,29 @@ function New-VSGlueClassifier { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER XMLClassifier + A classifier for XML content. + Type: XMLClassifier Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-xmlclassifier UpdateType: Mutable .PARAMETER JsonClassifier + A classifier for JSON content. + Type: JsonClassifier Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-jsonclassifier UpdateType: Mutable .PARAMETER CsvClassifier + A classifier for comma-separated values CSV. + Type: CsvClassifier Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-csvclassifier UpdateType: Mutable .PARAMETER GrokClassifier + A classifier that uses grok. + Type: GrokClassifier Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-grokclassifier UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 b/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 index c956aa5cf..993890290 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 @@ -1,10 +1,10 @@ function New-VSGlueConnection { <# .SYNOPSIS - Adds an AWS::Glue::Connection resource to the template. + Adds an AWS::Glue::Connection resource to the template. The AWS::Glue::Connection resource specifies an AWS Glue connection to a data source. For more information, see Adding a Connection to Your Data Store: https://docs.aws.amazon.com/dg/populate-add-connection.html and Connection Structure: https://docs.aws.amazon.com/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Connection resource to the template. + Adds an AWS::Glue::Connection resource to the template. The AWS::Glue::Connection resource specifies an AWS Glue connection to a data source. For more information, see Adding a Connection to Your Data Store: https://docs.aws.amazon.com/dg/populate-add-connection.html and Connection Structure: https://docs.aws.amazon.com/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html @@ -13,11 +13,16 @@ function New-VSGlueConnection { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConnectionInput + The connection that you want to create. + Type: ConnectionInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-connectioninput UpdateType: Mutable .PARAMETER CatalogId + The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID. +To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-catalogid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 b/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 index d4bb262bb..ab1960c25 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 @@ -1,10 +1,10 @@ function New-VSGlueCrawler { <# .SYNOPSIS - Adds an AWS::Glue::Crawler resource to the template. + Adds an AWS::Glue::Crawler resource to the template. The AWS::Glue::Crawler resource specifies an AWS Glue crawler. For more information, see Cataloging Tables with a Crawler: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html and Crawler Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-crawling.html#aws-glue-api-crawler-crawling-Crawler in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Crawler resource to the template. + Adds an AWS::Glue::Crawler resource to the template. The AWS::Glue::Crawler resource specifies an AWS Glue crawler. For more information, see Cataloging Tables with a Crawler: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html and Crawler Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-crawling.html#aws-glue-api-crawler-crawling-Crawler in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html @@ -13,62 +13,86 @@ function New-VSGlueCrawler { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Role + The Amazon Resource Name ARN of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service Amazon S3 data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-role PrimitiveType: String UpdateType: Mutable .PARAMETER Classifiers + A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-classifiers UpdateType: Mutable .PARAMETER Description + A description of the crawler. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-description PrimitiveType: String UpdateType: Mutable .PARAMETER SchemaChangePolicy + The policy that specifies update and delete behaviors for the crawler. + Type: SchemaChangePolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schemachangepolicy UpdateType: Mutable .PARAMETER Configuration + Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler: https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-configuration PrimitiveType: String UpdateType: Mutable .PARAMETER Schedule + For scheduled crawlers, the schedule when the crawler runs. + Type: Schedule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schedule UpdateType: Mutable .PARAMETER DatabaseName + The name of the database in which the crawler's output is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER Targets + A collection of targets to crawl. + Type: Targets Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-targets UpdateType: Mutable .PARAMETER CrawlerSecurityConfiguration + The name of the SecurityConfiguration structure to be used by this crawler. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-crawlersecurityconfiguration PrimitiveType: String UpdateType: Mutable .PARAMETER TablePrefix + The prefix added to the names of tables that are created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tableprefix PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html in the developer guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the crawler. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 index 1dc800376..1f75ce104 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 @@ -1,10 +1,10 @@ function New-VSGlueDataCatalogEncryptionSettings { <# .SYNOPSIS - Adds an AWS::Glue::DataCatalogEncryptionSettings resource to the template. + Adds an AWS::Glue::DataCatalogEncryptionSettings resource to the template. Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter. .DESCRIPTION - Adds an AWS::Glue::DataCatalogEncryptionSettings resource to the template. + Adds an AWS::Glue::DataCatalogEncryptionSettings resource to the template. Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html @@ -13,11 +13,15 @@ function New-VSGlueDataCatalogEncryptionSettings { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DataCatalogEncryptionSettings + Contains configuration information for maintaining Data Catalog security. + Type: DataCatalogEncryptionSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings UpdateType: Mutable .PARAMETER CatalogId + The ID of the Data Catalog in which the settings are created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-catalogid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 index 719df441a..5197c95a2 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 @@ -1,10 +1,10 @@ function New-VSGlueDatabase { <# .SYNOPSIS - Adds an AWS::Glue::Database resource to the template. + Adds an AWS::Glue::Database resource to the template. The AWS::Glue::Database resource specifies a logical grouping of tables in AWS Glue. For more information, see Defining a Database in Your Data Catalog: https://docs.aws.amazon.com/glue/latest/dg/define-database.html and Database Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-databases.html#aws-glue-api-catalog-databases-Database in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Database resource to the template. + Adds an AWS::Glue::Database resource to the template. The AWS::Glue::Database resource specifies a logical grouping of tables in AWS Glue. For more information, see Defining a Database in Your Data Catalog: https://docs.aws.amazon.com/glue/latest/dg/define-database.html and Database Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-databases.html#aws-glue-api-catalog-databases-Database in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html @@ -13,11 +13,16 @@ function New-VSGlueDatabase { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DatabaseInput + The metadata for the database. + Type: DatabaseInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-databaseinput UpdateType: Mutable .PARAMETER CatalogId + The AWS account ID for the account in which to create the catalog object. +To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-catalogid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 index efeb99033..9598ebff8 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 @@ -1,10 +1,10 @@ function New-VSGlueDevEndpoint { <# .SYNOPSIS - Adds an AWS::Glue::DevEndpoint resource to the template. + Adds an AWS::Glue::DevEndpoint resource to the template. The AWS::Glue::DevEndpoint resource specifies a development endpoint where a developer can remotely debug ETL scripts for AWS Glue. For more information, see DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the AWS Glue Developer Guide. .DESCRIPTION - Adds an AWS::Glue::DevEndpoint resource to the template. + Adds an AWS::Glue::DevEndpoint resource to the template. The AWS::Glue::DevEndpoint resource specifies a development endpoint where a developer can remotely debug ETL scripts for AWS Glue. For more information, see DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the AWS Glue Developer Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html @@ -13,72 +13,102 @@ function New-VSGlueDevEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ExtraJarsS3Path + The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint. +You can only use pure Java/Scala libraries with a DevEndpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrajarss3path PrimitiveType: String UpdateType: Mutable .PARAMETER PublicKey + The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickey PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfNodes + The number of AWS Glue Data Processing Units DPUs allocated to this DevEndpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofnodes PrimitiveType: Integer UpdateType: Mutable .PARAMETER Arguments + + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-arguments PrimitiveType: Json UpdateType: Mutable .PARAMETER SubnetId + The subnet ID for this DevEndpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-subnetid PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroupIds + A list of security group identifiers used in this DevEndpoint. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securitygroupids UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role used in this DevEndpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER WorkerType + + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-workertype PrimitiveType: String UpdateType: Mutable .PARAMETER EndpointName + The name of the DevEndpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-endpointname PrimitiveType: String UpdateType: Immutable .PARAMETER GlueVersion + + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-glueversion PrimitiveType: String UpdateType: Mutable .PARAMETER ExtraPythonLibsS3Path + The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma. +You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas: http://pandas.pydata.org/ Python data analysis library, are not currently supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrapythonlibss3path PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityConfiguration + The name of the SecurityConfiguration structure to be used with this DevEndpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securityconfiguration PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfWorkers + + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofworkers PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tags + The tags to use with this DevEndpoint. You can use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html in the developer guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 b/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 index b12f478ff..089216999 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 @@ -1,10 +1,10 @@ function New-VSGlueJob { <# .SYNOPSIS - Adds an AWS::Glue::Job resource to the template. + Adds an AWS::Glue::Job resource to the template. The AWS::Glue::Job resource specifies an AWS Glue job in the data catalog. For more information, see Adding Jobs in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/add-job.html and Job Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job in the *AWS Glue Developer Guide.* .DESCRIPTION - Adds an AWS::Glue::Job resource to the template. + Adds an AWS::Glue::Job resource to the template. The AWS::Glue::Job resource specifies an AWS Glue job in the data catalog. For more information, see Adding Jobs in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/add-job.html and Job Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job in the *AWS Glue Developer Guide.* .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html @@ -13,16 +13,22 @@ function New-VSGlueJob { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Connections + The connections used for this job. + Type: ConnectionsList Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-connections UpdateType: Mutable .PARAMETER MaxRetries + The maximum number of times to retry this job after a JobRun fails. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxretries PrimitiveType: Double UpdateType: Mutable .PARAMETER Description + A description of the job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-description PrimitiveType: String UpdateType: Mutable @@ -33,21 +39,32 @@ function New-VSGlueJob { UpdateType: Mutable .PARAMETER AllocatedCapacity + The number of capacity units that are allocated to this job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-allocatedcapacity PrimitiveType: Double UpdateType: Mutable .PARAMETER Name + The name you assign to this job definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-name PrimitiveType: String UpdateType: Immutable .PARAMETER Role + The name or Amazon Resource Name ARN of the IAM role associated with this job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-role PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultArguments + The default arguments for this job, specified as name-value pairs. +You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes. +For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html in the *AWS Glue Developer Guide*. +For information about the key-value pairs that AWS Glue consumes to set up your job, see Special Parameters Used by AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html in the *AWS Glue Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-defaultarguments PrimitiveType: Json UpdateType: Mutable @@ -58,46 +75,74 @@ function New-VSGlueJob { UpdateType: Mutable .PARAMETER WorkerType + The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. ++ For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. ++ For the G.1X worker type, each worker maps to 1 DPU 4 vCPU, 16 GB of memory, 64 GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. ++ For the G.2X worker type, each worker maps to 2 DPU 8 vCPU, 32 GB of memory, 128 GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-workertype PrimitiveType: String UpdateType: Mutable .PARAMETER LogUri + This field is reserved for future use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-loguri PrimitiveType: String UpdateType: Mutable .PARAMETER Command + The code that executes a job. + Type: JobCommand Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-command UpdateType: Mutable .PARAMETER GlueVersion + Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark. +For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version: https://docs.aws.amazon.com/glue/latest/dg/add-job.html in the developer guide. +Jobs that are created without specifying a Glue version default to Glue 0.9. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-glueversion PrimitiveType: String UpdateType: Mutable .PARAMETER ExecutionProperty + The maximum number of concurrent runs that are allowed for this job. + Type: ExecutionProperty Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionproperty UpdateType: Mutable .PARAMETER SecurityConfiguration + The name of the SecurityConfiguration structure to be used with this job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-securityconfiguration PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfWorkers + The number of workers of a defined workerType that are allocated when a job runs. +The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-numberofworkers PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tags + The tags to use with this job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER MaxCapacity + The number of AWS Glue data processing units DPUs that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. +Do not set Max Capacity if using WorkerType and NumberOfWorkers. +The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job: ++ When you specify a Python shell job JobCommand.Name="pythonshell", you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. ++ When you specify an Apache Spark ETL job JobCommand.Name="glueetl", you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxcapacity PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 b/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 index 2caa0cb7f..fbd57e3e0 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 @@ -1,10 +1,10 @@ function New-VSGlueMLTransform { <# .SYNOPSIS - Adds an AWS::Glue::MLTransform resource to the template. + Adds an AWS::Glue::MLTransform resource to the template. The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms. .DESCRIPTION - Adds an AWS::Glue::MLTransform resource to the template. + Adds an AWS::Glue::MLTransform resource to the template. The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html @@ -13,56 +13,92 @@ function New-VSGlueMLTransform { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Role + The name or Amazon Resource Name ARN of the IAM role with the required permissions. This role needs permission to your Amazon Simple Storage Service Amazon S3 sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-role PrimitiveType: String UpdateType: Mutable .PARAMETER MaxRetries + The maximum number of times to retry after an MLTaskRun of the machine learning transform fails. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxretries PrimitiveType: Integer UpdateType: Mutable .PARAMETER WorkerType + The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X. ++ For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. ++ For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. ++ For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. +MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType. ++ If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set. ++ If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set. ++ If WorkerType is set, then NumberOfWorkers is required and vice versa. ++ MaxCapacity and NumberOfWorkers must both be at least 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-workertype PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A user-defined, long-form description text for the machine learning transform. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-description PrimitiveType: String UpdateType: Mutable .PARAMETER Timeout + The timeout in minutes of the machine learning transform. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-timeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER GlueVersion + For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-glueversion PrimitiveType: String UpdateType: Mutable .PARAMETER TransformParameters + The algorithm-specific parameters that are associated with the machine learning transform. + Type: TransformParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformparameters UpdateType: Mutable .PARAMETER InputRecordTables + A list of AWS Glue table definitions used by the transform. + Type: InputRecordTables Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-inputrecordtables UpdateType: Immutable .PARAMETER NumberOfWorkers + The number of workers of a defined workerType that are allocated when a task of the transform runs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-numberofworkers PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + A user-defined name for the machine learning transform. Names are required to be unique. Name is optional. If you supply Name, the stack cannot be repeatedly created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-name PrimitiveType: String UpdateType: Mutable .PARAMETER MaxCapacity + The number of AWS Glue data processing units DPUs that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page: http://aws.amazon.com/glue/pricing/. +MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType. ++ If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set. ++ If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set. ++ If WorkerType is set, then NumberOfWorkers is required and vice versa. ++ MaxCapacity and NumberOfWorkers must both be at least 1. +When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxcapacity PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 b/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 index 04ab8c45e..f3cb0645d 100644 --- a/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 @@ -1,10 +1,10 @@ function New-VSGluePartition { <# .SYNOPSIS - Adds an AWS::Glue::Partition resource to the template. + Adds an AWS::Glue::Partition resource to the template. The AWS::Glue::Partition resource creates an AWS Glue partition, which represents a slice of table data. For more information, see CreatePartition Action: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-CreatePartition and Partition Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-Partition in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Partition resource to the template. + Adds an AWS::Glue::Partition resource to the template. The AWS::Glue::Partition resource creates an AWS Glue partition, which represents a slice of table data. For more information, see CreatePartition Action: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-CreatePartition and Partition Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-Partition in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html @@ -13,21 +13,30 @@ function New-VSGluePartition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TableName + The name of the metadata table in which the partition is to be created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-tablename PrimitiveType: String UpdateType: Immutable .PARAMETER DatabaseName + The name of the catalog database in which to create the partition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-databasename PrimitiveType: String UpdateType: Immutable .PARAMETER CatalogId + The AWS account ID of the catalog in which the partion is to be created. +To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-catalogid PrimitiveType: String UpdateType: Immutable .PARAMETER PartitionInput + The structure used to create and update a partition. + Type: PartitionInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-partitioninput UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 index e3c12e9dc..84c94b176 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 @@ -1,10 +1,10 @@ function New-VSGlueSecurityConfiguration { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration resource to the template. + Adds an AWS::Glue::SecurityConfiguration resource to the template. Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints: https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html. .DESCRIPTION - Adds an AWS::Glue::SecurityConfiguration resource to the template. + Adds an AWS::Glue::SecurityConfiguration resource to the template. Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints: https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html @@ -13,11 +13,15 @@ function New-VSGlueSecurityConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EncryptionConfiguration + The encryption configuration associated with this security configuration. + Type: EncryptionConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration UpdateType: Mutable .PARAMETER Name + The name of the security configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 b/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 index f47f6fde2..36504bb48 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 @@ -1,10 +1,10 @@ function New-VSGlueTable { <# .SYNOPSIS - Adds an AWS::Glue::Table resource to the template. + Adds an AWS::Glue::Table resource to the template. The AWS::Glue::Table resource specifies tabular data in the AWS Glue data catalog. For more information, see Defining Tables in the AWS Glue Data Catalog: https://docs.aws.amazon.com/glue/latest/dg/tables-described.html and Table Structure : https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-Table in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Table resource to the template. + Adds an AWS::Glue::Table resource to the template. The AWS::Glue::Table resource specifies tabular data in the AWS Glue data catalog. For more information, see Defining Tables in the AWS Glue Data Catalog: https://docs.aws.amazon.com/glue/latest/dg/tables-described.html and Table Structure : https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-Table in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html @@ -13,16 +13,22 @@ function New-VSGlueTable { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TableInput + A structure used to define a table. + Type: TableInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput UpdateType: Mutable .PARAMETER DatabaseName + The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename PrimitiveType: String UpdateType: Immutable .PARAMETER CatalogId + The ID of the Data Catalog in which to create the Table. If none is supplied, the AWS account ID is used by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 b/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 index 4a84d3b19..dcf20f531 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 @@ -1,10 +1,10 @@ function New-VSGlueTrigger { <# .SYNOPSIS - Adds an AWS::Glue::Trigger resource to the template. + Adds an AWS::Glue::Trigger resource to the template. The AWS::Glue::Trigger resource specifies triggers that run AWS Glue jobs. For more information, see Triggering Jobs in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html and Trigger Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Trigger in the *AWS Glue Developer Guide*. .DESCRIPTION - Adds an AWS::Glue::Trigger resource to the template. + Adds an AWS::Glue::Trigger resource to the template. The AWS::Glue::Trigger resource specifies triggers that run AWS Glue jobs. For more information, see Triggering Jobs in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html and Trigger Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Trigger in the *AWS Glue Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html @@ -13,6 +13,8 @@ function New-VSGlueTrigger { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of trigger that this is. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-type PrimitiveType: String UpdateType: Mutable @@ -23,11 +25,15 @@ function New-VSGlueTrigger { UpdateType: Mutable .PARAMETER Description + A description of this trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-description PrimitiveType: String UpdateType: Mutable .PARAMETER Actions + The actions initiated by this trigger. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-actions ItemType: Action @@ -39,21 +45,29 @@ function New-VSGlueTrigger { UpdateType: Immutable .PARAMETER Schedule + A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html in the *AWS Glue Developer Guide*. For example, to run something every day at 12:15 UTC, specify cron15 12 * * ? *. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-schedule PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to use with this trigger. You can use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html in the developer guide.. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-name PrimitiveType: String UpdateType: Immutable .PARAMETER Predicate + The predicate of this trigger, which defines when it will fire. + Type: Predicate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-predicate UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 index d691b784d..55f20bd1a 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassConnectorDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::ConnectorDefinition resource to the template. + Adds an AWS::Greengrass::ConnectorDefinition resource to the template. The AWS::Greengrass::ConnectorDefinition resource represents a connector definition for AWS IoT Greengrass. Connector definitions are used to organize your connector definition versions. .DESCRIPTION - Adds an AWS::Greengrass::ConnectorDefinition resource to the template. + Adds an AWS::Greengrass::ConnectorDefinition resource to the template. The AWS::Greengrass::ConnectorDefinition resource represents a connector definition for AWS IoT Greengrass. Connector definitions are used to organize your connector definition versions. + +Connector definitions can reference multiple connector definition versions. All connector definition versions must be associated with a connector definition. Each connector definition version can contain one or more connectors. + +**Note** + +When you create a connector definition, you can optionally include an initial connector definition version. To associate a connector definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html resource and specify the ID of this connector definition. + +After you create the connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassConnectorDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The connector definition version to include when the connector definition is created. A connector definition version contains a list of https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html property types. +To associate a connector definition version after the connector definition is created, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html resource and specify the ID of this connector definition. + Type: ConnectorDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the connector definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 index a7cff47b3..52ed7980d 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassConnectorDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::ConnectorDefinitionVersion resource to the template. + Adds an AWS::Greengrass::ConnectorDefinitionVersion resource to the template. The AWS::Greengrass::ConnectorDefinitionVersion resource represents a connector definition version for AWS IoT Greengrass. A connector definition version contains a list of connectors. .DESCRIPTION - Adds an AWS::Greengrass::ConnectorDefinitionVersion resource to the template. + Adds an AWS::Greengrass::ConnectorDefinitionVersion resource to the template. The AWS::Greengrass::ConnectorDefinitionVersion resource represents a connector definition version for AWS IoT Greengrass. A connector definition version contains a list of connectors. + +**Note** + +To create a connector definition version, you must specify the ID of the connector definition that you want to associate with the version. For information about creating a connector definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html. + +After you create a connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html @@ -13,12 +19,16 @@ function New-VSGreengrassConnectorDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Connectors + The connectors in this version. Only one instance of a given connector can be added to the connector definition version at a time. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectors ItemType: Connector UpdateType: Immutable .PARAMETER ConnectorDefinitionId + The ID of the connector definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectordefinitionid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 index 9dc415224..07799f7f2 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassCoreDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::CoreDefinition resource to the template. + Adds an AWS::Greengrass::CoreDefinition resource to the template. The AWS::Greengrass::CoreDefinition resource represents a core definition for AWS IoT Greengrass. Core definitions are used to organize your core definition versions. .DESCRIPTION - Adds an AWS::Greengrass::CoreDefinition resource to the template. + Adds an AWS::Greengrass::CoreDefinition resource to the template. The AWS::Greengrass::CoreDefinition resource represents a core definition for AWS IoT Greengrass. Core definitions are used to organize your core definition versions. + +Core definitions can reference multiple core definition versions. All core definition versions must be associated with a core definition. Each core definition version can contain one Greengrass core. + +**Note** + +When you create a core definition, you can optionally include an initial core definition version. To associate a core definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html resource and specify the ID of this core definition. + +After you create the core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassCoreDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The core definition version to include when the core definition is created. Currently, a core definition version can contain only one https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html. +To associate a core definition version after the core definition is created, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html resource and specify the ID of this core definition. + Type: CoreDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the core definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 index a7439b451..abf0fc240 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassCoreDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::CoreDefinitionVersion resource to the template. + Adds an AWS::Greengrass::CoreDefinitionVersion resource to the template. The AWS::Greengrass::CoreDefinitionVersion resource represents a core definition version for AWS IoT Greengrass. A core definition version contains a Greengrass core. .DESCRIPTION - Adds an AWS::Greengrass::CoreDefinitionVersion resource to the template. + Adds an AWS::Greengrass::CoreDefinitionVersion resource to the template. The AWS::Greengrass::CoreDefinitionVersion resource represents a core definition version for AWS IoT Greengrass. A core definition version contains a Greengrass core. + +**Note** + +To create a core definition version, you must specify the ID of the core definition that you want to associate with the version. For information about creating a core definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html. + +After you create a core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html @@ -13,12 +19,16 @@ function New-VSGreengrassCoreDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Cores + The Greengrass core in this version. Currently, the Cores property for a core definition version can contain only one core. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-cores ItemType: Core UpdateType: Immutable .PARAMETER CoreDefinitionId + The ID of the core definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-coredefinitionid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 index 3b906f265..9f948fb41 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassDeviceDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::DeviceDefinition resource to the template. + Adds an AWS::Greengrass::DeviceDefinition resource to the template. The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass. Device definitions are used to organize your device definition versions. .DESCRIPTION - Adds an AWS::Greengrass::DeviceDefinition resource to the template. + Adds an AWS::Greengrass::DeviceDefinition resource to the template. The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass. Device definitions are used to organize your device definition versions. + +Device definitions can reference multiple device definition versions. All device definition versions must be associated with a device definition. Each device definition version can contain one or more devices. + +**Note** + +When you create a device definition, you can optionally include an initial device definition version. To associate a device definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html resource and specify the ID of this device definition. + +After you create the device definition version that contains the devices you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassDeviceDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The device definition version to include when the device definition is created. A device definition version contains a list of https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html property types. +To associate a device definition version after the device definition is created, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html resource and specify the ID of this device definition. + Type: DeviceDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the device definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 index 5c6aa4788..c43b79a96 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassDeviceDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::DeviceDefinitionVersion resource to the template. + Adds an AWS::Greengrass::DeviceDefinitionVersion resource to the template. The AWS::Greengrass::DeviceDefinitionVersion resource represents a device definition version for AWS IoT Greengrass. A device definition version contains a list of devices. .DESCRIPTION - Adds an AWS::Greengrass::DeviceDefinitionVersion resource to the template. + Adds an AWS::Greengrass::DeviceDefinitionVersion resource to the template. The AWS::Greengrass::DeviceDefinitionVersion resource represents a device definition version for AWS IoT Greengrass. A device definition version contains a list of devices. + +**Note** + +To create a device definition version, you must specify the ID of the device definition that you want to associate with the version. For information about creating a device definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html. + +After you create a device definition version that contains the devices you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html @@ -13,11 +19,15 @@ function New-VSGreengrassDeviceDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeviceDefinitionId + The ID of the device definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devicedefinitionid PrimitiveType: String UpdateType: Immutable .PARAMETER Devices + The devices in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devices ItemType: Device diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 index d4c42359b..27343d16e 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassFunctionDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinition resource to the template. + Adds an AWS::Greengrass::FunctionDefinition resource to the template. The AWS::Greengrass::FunctionDefinition resource represents a function definition for AWS IoT Greengrass. Function definitions are used to organize your function definition versions. .DESCRIPTION - Adds an AWS::Greengrass::FunctionDefinition resource to the template. + Adds an AWS::Greengrass::FunctionDefinition resource to the template. The AWS::Greengrass::FunctionDefinition resource represents a function definition for AWS IoT Greengrass. Function definitions are used to organize your function definition versions. + +Function definitions can reference multiple function definition versions. All function definition versions must be associated with a function definition. Each function definition version can contain one or more functions. + +**Note** + +When you create a function definition, you can optionally include an initial function definition version. To associate a function definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html resource and specify the ID of this function definition. + +After you create the function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassFunctionDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The function definition version to include when the function definition is created. A function definition version contains a list of https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html property types. +To associate a function definition version after the function definition is created, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html resource and specify the ID of this function definition. + Type: FunctionDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the function definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 index 3cc1fd9df..0adf79da4 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassFunctionDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::FunctionDefinitionVersion resource to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion resource to the template. The AWS::Greengrass::FunctionDefinitionVersion resource represents a function definition version for AWS IoT Greengrass. A function definition version contains contain a list of functions. .DESCRIPTION - Adds an AWS::Greengrass::FunctionDefinitionVersion resource to the template. + Adds an AWS::Greengrass::FunctionDefinitionVersion resource to the template. The AWS::Greengrass::FunctionDefinitionVersion resource represents a function definition version for AWS IoT Greengrass. A function definition version contains contain a list of functions. + +**Note** + +To create a function definition version, you must specify the ID of the function definition that you want to associate with the version. For information about creating a function definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html. + +After you create a function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html @@ -13,17 +19,23 @@ function New-VSGreengrassFunctionDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DefaultConfig + The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings. + Type: DefaultConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-defaultconfig UpdateType: Immutable .PARAMETER Functions + The functions in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functions ItemType: Function UpdateType: Immutable .PARAMETER FunctionDefinitionId + The ID of the function definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functiondefinitionid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 index 74f3b53fd..547bb7fbc 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 @@ -1,10 +1,30 @@ function New-VSGreengrassGroup { <# .SYNOPSIS - Adds an AWS::Greengrass::Group resource to the template. + Adds an AWS::Greengrass::Group resource to the template. AWS IoT Greengrass seamlessly extends AWS to edge devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. With AWS IoT Greengrass, connected devices can run AWS Lambda functions, execute predictions based on machine learning models, keep device data in sync, and communicate with other devices securely – even when not connected to the internet. For more information, see the AWS IoT Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html. .DESCRIPTION - Adds an AWS::Greengrass::Group resource to the template. + Adds an AWS::Greengrass::Group resource to the template. AWS IoT Greengrass seamlessly extends AWS to edge devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. With AWS IoT Greengrass, connected devices can run AWS Lambda functions, execute predictions based on machine learning models, keep device data in sync, and communicate with other devices securely – even when not connected to the internet. For more information, see the AWS IoT Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html. + +**Note** + +For AWS Region support, see AWS CloudFormation Support for AWS IoT Greengrass: https://docs.aws.amazon.com/greengrass/latest/developerguide/cloudformation-support.html in the *AWS IoT Greengrass Developer Guide*. + +The AWS::Greengrass::Group resource represents a group in AWS IoT Greengrass. In the AWS IoT Greengrass API, groups are used to organize your group versions. + +Groups can reference multiple group versions. All group versions must be associated with a group. A group version references a device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. + +To deploy a group version, the group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. + +**Note** + +When you create a group, you can optionally include an initial group version. To associate a group version later, create a https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html resource and specify the ID of this group. + +To change group components (such as devices, subscriptions, or functions, you must create new versions. This is because versions are immutable. For example, to add a function, you create a function definition version that contains the new function (and all other functions that you want to deploy. Then you create a group version that references the new function definition version (and all other version types that you want to deploy. + +**Deploying a Group Version** + +After you create the group version in your AWS CloudFormation template, you can deploy it using the https://docs.aws.amazon.com/greengrass/latest/apireference/createdeployment-post.html: https://docs.aws.amazon.com/greengrass/latest/apireference/createdeployment-post.html command in the AWS CLI or from the **Greengrass** node in the AWS IoT console. To deploy a group version, you must have a Greengrass service role associated with your AWS account. For more information, see AWS CloudFormation Support for AWS IoT Greengrass: https://docs.aws.amazon.com/greengrass/latest/developerguide/cloudformation-support.html in the *AWS IoT Greengrass Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html @@ -13,21 +33,38 @@ function New-VSGreengrassGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The group version to include when the group is created. A group version references the Amazon Resource Name ARN of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. +To associate a group version after the group is created, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html resource and specify the ID of this group. + Type: GroupVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-initialversion UpdateType: Immutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role attached to the group. This role contains the permissions that Lambda functions and connectors use to interact with other AWS services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 index f19875fb1..43b17e205 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 @@ -1,10 +1,14 @@ function New-VSGreengrassGroupVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::GroupVersion resource to the template. + Adds an AWS::Greengrass::GroupVersion resource to the template. The AWS::Greengrass::GroupVersion resource represents a group version in AWS IoT Greengrass. A group version references a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. .DESCRIPTION - Adds an AWS::Greengrass::GroupVersion resource to the template. + Adds an AWS::Greengrass::GroupVersion resource to the template. The AWS::Greengrass::GroupVersion resource represents a group version in AWS IoT Greengrass. A group version references a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. + +**Note** + +To create a group version, you must specify the ID of the group that you want to associate with the version. For information about creating a group, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html @@ -13,41 +17,57 @@ function New-VSGreengrassGroupVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LoggerDefinitionVersionArn + The ARN of the logger definition version that contains the loggers you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-loggerdefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER DeviceDefinitionVersionArn + The ARN of the device definition version that contains the devices you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-devicedefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionDefinitionVersionArn + The ARN of the function definition version that contains the functions you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-functiondefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER CoreDefinitionVersionArn + The ARN of the core definition version that contains the core you want to deploy with the group version. Currently, the core definition version can contain only one core. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-coredefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceDefinitionVersionArn + The ARN of the resource definition version that contains the resources you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-resourcedefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER ConnectorDefinitionVersionArn + The Amazon Resource Name ARN of the connector definition version that contains the connectors you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-connectordefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER SubscriptionDefinitionVersionArn + The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-subscriptiondefinitionversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER GroupId + The ID of the group associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-groupid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 index d759e6f0f..864867eb2 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassLoggerDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::LoggerDefinition resource to the template. + Adds an AWS::Greengrass::LoggerDefinition resource to the template. The AWS::Greengrass::LoggerDefinition resource represents a logger definition for AWS IoT Greengrass. Logger definitions are used to organize your logger definition versions. .DESCRIPTION - Adds an AWS::Greengrass::LoggerDefinition resource to the template. + Adds an AWS::Greengrass::LoggerDefinition resource to the template. The AWS::Greengrass::LoggerDefinition resource represents a logger definition for AWS IoT Greengrass. Logger definitions are used to organize your logger definition versions. + +Logger definitions can reference multiple logger definition versions. All logger definition versions must be associated with a logger definition. Each logger definition version can contain one or more loggers. + +**Note** + +When you create a logger definition, you can optionally include an initial logger definition version. To associate a logger definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html resource and specify the ID of this logger definition. + +After you create the logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassLoggerDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The logger definition version to include when the logger definition is created. A logger definition version contains a list of https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html property types. +To associate a logger definition version after the logger definition is created, create an AWS::Greengrass::LoggerDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html resource and specify the ID of this logger definition. + Type: LoggerDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the logger definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 index 89c984c16..ba050783c 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassLoggerDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::LoggerDefinitionVersion resource to the template. + Adds an AWS::Greengrass::LoggerDefinitionVersion resource to the template. The AWS::Greengrass::LoggerDefinitionVersion resource represents a logger definition version for AWS IoT Greengrass. A logger definition version contains a list of loggers. .DESCRIPTION - Adds an AWS::Greengrass::LoggerDefinitionVersion resource to the template. + Adds an AWS::Greengrass::LoggerDefinitionVersion resource to the template. The AWS::Greengrass::LoggerDefinitionVersion resource represents a logger definition version for AWS IoT Greengrass. A logger definition version contains a list of loggers. + +**Note** + +To create a logger definition version, you must specify the ID of the logger definition that you want to associate with the version. For information about creating a logger definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html. + +After you create a logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html @@ -13,11 +19,15 @@ function New-VSGreengrassLoggerDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LoggerDefinitionId + The ID of the logger definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggerdefinitionid PrimitiveType: String UpdateType: Immutable .PARAMETER Loggers + The loggers in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggers ItemType: Logger diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 index 315f470c9..0c4100323 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassResourceDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinition resource to the template. + Adds an AWS::Greengrass::ResourceDefinition resource to the template. The AWS::Greengrass::ResourceDefinition resource represents a resource definition for AWS IoT Greengrass. Resource definitions are used to organize your resource definition versions. .DESCRIPTION - Adds an AWS::Greengrass::ResourceDefinition resource to the template. + Adds an AWS::Greengrass::ResourceDefinition resource to the template. The AWS::Greengrass::ResourceDefinition resource represents a resource definition for AWS IoT Greengrass. Resource definitions are used to organize your resource definition versions. + +Resource definitions can reference multiple resource definition versions. All resource definition versions must be associated with a resource definition. Each resource definition version can contain one or more resources. (In AWS CloudFormation, resources are named *resource instances*. + +**Note** + +When you create a resource definition, you can optionally include an initial resource definition version. To associate a resource definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html resource and specify the ID of this resource definition. + +After you create the resource definition version that contains the resources you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassResourceDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The resource definition version to include when the resource definition is created. A resource definition version contains a list of https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html property types. +To associate a resource definition version after the resource definition is created, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html resource and specify the ID of this resource definition. + Type: ResourceDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the resource definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 index 225bd03b7..0a8a75825 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassResourceDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::ResourceDefinitionVersion resource to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion resource to the template. The AWS::Greengrass::ResourceDefinitionVersion resource represents a resource definition version for AWS IoT Greengrass. A resource definition version contains a list of resources. (In AWS CloudFormation, resources are named *resource instances*. .DESCRIPTION - Adds an AWS::Greengrass::ResourceDefinitionVersion resource to the template. + Adds an AWS::Greengrass::ResourceDefinitionVersion resource to the template. The AWS::Greengrass::ResourceDefinitionVersion resource represents a resource definition version for AWS IoT Greengrass. A resource definition version contains a list of resources. (In AWS CloudFormation, resources are named *resource instances*. + +**Note** + +To create a resource definition version, you must specify the ID of the resource definition that you want to associate with the version. For information about creating a resource definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html. + +After you create a resource definition version that contains the resources you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html @@ -13,12 +19,16 @@ function New-VSGreengrassResourceDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Resources + The resources in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resources ItemType: ResourceInstance UpdateType: Immutable .PARAMETER ResourceDefinitionId + The ID of the resource definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resourcedefinitionid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 index 3ca7ec998..1c490120a 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 @@ -1,10 +1,18 @@ function New-VSGreengrassSubscriptionDefinition { <# .SYNOPSIS - Adds an AWS::Greengrass::SubscriptionDefinition resource to the template. + Adds an AWS::Greengrass::SubscriptionDefinition resource to the template. The AWS::Greengrass::SubscriptionDefinition resource represents a subscription definition for AWS IoT Greengrass. Subscription definitions are used to organize your subscription definition versions. .DESCRIPTION - Adds an AWS::Greengrass::SubscriptionDefinition resource to the template. + Adds an AWS::Greengrass::SubscriptionDefinition resource to the template. The AWS::Greengrass::SubscriptionDefinition resource represents a subscription definition for AWS IoT Greengrass. Subscription definitions are used to organize your subscription definition versions. + +Subscription definitions can reference multiple subscription definition versions. All subscription definition versions must be associated with a subscription definition. Each subscription definition version can contain one or more subscriptions. + +**Note** + +When you create a subscription definition, you can optionally include an initial subscription definition version. To associate a subscription definition version later, create an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html resource and specify the ID of this subscription definition. + +After you create the subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html @@ -13,16 +21,31 @@ function New-VSGreengrassSubscriptionDefinition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InitialVersion + The subscription definition version to include when the subscription definition is created. A subscription definition version contains a list of subscription : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html property types. +To associate a subscription definition version after the subscription definition is created, create an AWS::Greengrass::SubscriptionDefinitionVersion : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html resource and specify the ID of this subscription definition. + Type: SubscriptionDefinitionVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-initialversion UpdateType: Immutable .PARAMETER Tags + Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources: https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html in the *AWS IoT Greengrass Developer Guide*. +This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. + +"Tags": { +"KeyName0": "value", +"KeyName1": "value", +"KeyName2": "value" +} + + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the subscription definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 index b1e11961c..fbb7906e4 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 @@ -1,10 +1,16 @@ function New-VSGreengrassSubscriptionDefinitionVersion { <# .SYNOPSIS - Adds an AWS::Greengrass::SubscriptionDefinitionVersion resource to the template. + Adds an AWS::Greengrass::SubscriptionDefinitionVersion resource to the template. The AWS::Greengrass::SubscriptionDefinitionVersion resource represents a subscription definition version for AWS IoT Greengrass. A subscription definition version contains a list of subscriptions. .DESCRIPTION - Adds an AWS::Greengrass::SubscriptionDefinitionVersion resource to the template. + Adds an AWS::Greengrass::SubscriptionDefinitionVersion resource to the template. The AWS::Greengrass::SubscriptionDefinitionVersion resource represents a subscription definition version for AWS IoT Greengrass. A subscription definition version contains a list of subscriptions. + +**Note** + +To create a subscription definition version, you must specify the ID of the subscription definition that you want to associate with the version. For information about creating a subscription definition, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html. + +After you create a subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html @@ -13,11 +19,15 @@ function New-VSGreengrassSubscriptionDefinitionVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SubscriptionDefinitionId + The ID of the subscription definition associated with this version. This value is a GUID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptiondefinitionid PrimitiveType: String UpdateType: Immutable .PARAMETER Subscriptions + The subscriptions in this version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptions ItemType: Subscription diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 index 172b2f26b..395026a87 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 @@ -1,10 +1,10 @@ function New-VSGuardDutyDetector { <# .SYNOPSIS - Adds an AWS::GuardDuty::Detector resource to the template. + Adds an AWS::GuardDuty::Detector resource to the template. The AWS::GuardDuty::Detector resource specifies a new Amazon GuardDuty detector. A detector is an object that represents the Amazon GuardDuty service. A detector is required for Amazon GuardDuty to become operational. .DESCRIPTION - Adds an AWS::GuardDuty::Detector resource to the template. + Adds an AWS::GuardDuty::Detector resource to the template. The AWS::GuardDuty::Detector resource specifies a new Amazon GuardDuty detector. A detector is an object that represents the Amazon GuardDuty service. A detector is required for Amazon GuardDuty to become operational. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html @@ -13,11 +13,15 @@ function New-VSGuardDutyDetector { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FindingPublishingFrequency + A enumeration value that specifies how frequently finding updates are published. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-findingpublishingfrequency PrimitiveType: String UpdateType: Mutable .PARAMETER Enable + Specifies whether or not to enable the detector. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-enable PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 index 3ec654dbf..d97f7dc71 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 @@ -1,10 +1,10 @@ function New-VSGuardDutyFilter { <# .SYNOPSIS - Adds an AWS::GuardDuty::Filter resource to the template. + Adds an AWS::GuardDuty::Filter resource to the template. The AWS::GuardDuty::Filter resource specifies a new filter defined by the provided findingCriteria. .DESCRIPTION - Adds an AWS::GuardDuty::Filter resource to the template. + Adds an AWS::GuardDuty::Filter resource to the template. The AWS::GuardDuty::Filter resource specifies a new filter defined by the provided findingCriteria. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html @@ -13,31 +13,43 @@ function New-VSGuardDutyFilter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Action + Specifies the action that is to be applied to the findings that match the filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-action PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description of the filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-description PrimitiveType: String UpdateType: Mutable .PARAMETER DetectorId + The ID of the detector to associate the Filter with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-detectorid PrimitiveType: String UpdateType: Immutable .PARAMETER FindingCriteria + Represents the criteria to be used in the filter for querying findings. + Type: FindingCriteria Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-findingcriteria UpdateType: Mutable .PARAMETER Rank + Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-rank PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + The name of the filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 index 4a299f9c7..f4e4bf58a 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 @@ -1,10 +1,10 @@ function New-VSGuardDutyIPSet { <# .SYNOPSIS - Adds an AWS::GuardDuty::IPSet resource to the template. + Adds an AWS::GuardDuty::IPSet resource to the template. The AWS::GuardDuty::IPSet resource specifies a new IPSet. An IPSet is a list of trusted IP addresses from which secure communication is allowed with AWS infrastructure and applications. .DESCRIPTION - Adds an AWS::GuardDuty::IPSet resource to the template. + Adds an AWS::GuardDuty::IPSet resource to the template. The AWS::GuardDuty::IPSet resource specifies a new IPSet. An IPSet is a list of trusted IP addresses from which secure communication is allowed with AWS infrastructure and applications. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html @@ -13,26 +13,36 @@ function New-VSGuardDutyIPSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Format + The format of the file that contains the IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-format PrimitiveType: String UpdateType: Immutable .PARAMETER Activate + Indicated whether or not GuardDuty uses the IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-activate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DetectorId + The unique ID of the detector for the GuardDuty service to associate the IPSet with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-detectorid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name for the IPSet. This name is displayed in all findings that are triggered by activity associated with the IP addresses included in this IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-name PrimitiveType: String UpdateType: Mutable .PARAMETER Location + The URI of the file that contains the IPSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 index f7cd69ec3..9b77625bb 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 @@ -1,10 +1,10 @@ function New-VSGuardDutyMaster { <# .SYNOPSIS - Adds an AWS::GuardDuty::Master resource to the template. + Adds an AWS::GuardDuty::Master resource to the template. You can use the AWS::GuardDuty::Master resource in a GuardDuty member account to accept an invitation from a GuardDuty master account. The invitation to the member account must be sent prior to using the AWS::GuardDuty::Master resource to accept the master account's invitation. You can invite a member account by using the InviteMembers operation of the Amazon GuardDuty API, or by creating an AWS::GuardDuty::Member resource. .DESCRIPTION - Adds an AWS::GuardDuty::Master resource to the template. + Adds an AWS::GuardDuty::Master resource to the template. You can use the AWS::GuardDuty::Master resource in a GuardDuty member account to accept an invitation from a GuardDuty master account. The invitation to the member account must be sent prior to using the AWS::GuardDuty::Master resource to accept the master account's invitation. You can invite a member account by using the InviteMembers operation of the Amazon GuardDuty API, or by creating an AWS::GuardDuty::Member resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html @@ -13,16 +13,22 @@ function New-VSGuardDutyMaster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DetectorId + The unique ID of the detector associated with the GuardDuty master account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-detectorid PrimitiveType: String UpdateType: Immutable .PARAMETER MasterId + The AWS account ID of the account designated as the GuardDuty master account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-masterid PrimitiveType: String UpdateType: Immutable .PARAMETER InvitationId + The ID of the invitation that is sent to the account designated as a member account. You can find the invitation ID by using the ListInvitation action of the GuardDuty API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-invitationid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 index d8654bc16..d48ee3b20 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 @@ -1,10 +1,10 @@ function New-VSGuardDutyMember { <# .SYNOPSIS - Adds an AWS::GuardDuty::Member resource to the template. + Adds an AWS::GuardDuty::Member resource to the template. You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty master account. If the value of the Status property is not provided or is set to Created, a member account is created but not invited. If the value of the Status property is set to Invited, a member account is created and invited. A AWS::GuardDuty::Member resource must be created with the Status property set to Invited before the AWS::GuardDuty::Master resource can be created in a GuardDuty member account. .DESCRIPTION - Adds an AWS::GuardDuty::Member resource to the template. + Adds an AWS::GuardDuty::Member resource to the template. You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty master account. If the value of the Status property is not provided or is set to Created, a member account is created but not invited. If the value of the Status property is set to Invited, a member account is created and invited. A AWS::GuardDuty::Member resource must be created with the Status property set to Invited before the AWS::GuardDuty::Master resource can be created in a GuardDuty member account. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html @@ -13,31 +13,43 @@ function New-VSGuardDutyMember { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Status + You can use the Status property to update the status of the relationship between the member account and its master account. Valid values are Created and Invited when using a AWS::GuardDuty::Member resource. If the value for this property is not provided or set to Created, a member account is created but not invited. If the value of this property is set to Invited, a member account is created and invited. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-status PrimitiveType: String UpdateType: Mutable .PARAMETER MemberId + The AWS account ID of the account to designate as a member. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-memberid PrimitiveType: String UpdateType: Immutable .PARAMETER Email + The email address associated with the member account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-email PrimitiveType: String UpdateType: Immutable .PARAMETER Message + The message to include with the invitation sent to the member accounts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-message PrimitiveType: String UpdateType: Mutable .PARAMETER DisableEmailNotification + Specifies whether or not to disable email notification for the member account that you invite. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-disableemailnotification PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DetectorId + The ID of the detector associated with the GuardDuty service to add the member to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-detectorid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 index 9261cbbb8..418b77285 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 @@ -1,10 +1,10 @@ function New-VSGuardDutyThreatIntelSet { <# .SYNOPSIS - Adds an AWS::GuardDuty::ThreatIntelSet resource to the template. + Adds an AWS::GuardDuty::ThreatIntelSet resource to the template. The AWS::GuardDuty::ThreatIntelSet resource specifies a new ThreatIntelSet. A ThreatIntelSet consists of known malicious IP addresses. GuardDuty generates findings based on the ThreatIntelSet when it is activated. .DESCRIPTION - Adds an AWS::GuardDuty::ThreatIntelSet resource to the template. + Adds an AWS::GuardDuty::ThreatIntelSet resource to the template. The AWS::GuardDuty::ThreatIntelSet resource specifies a new ThreatIntelSet. A ThreatIntelSet consists of known malicious IP addresses. GuardDuty generates findings based on the ThreatIntelSet when it is activated. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html @@ -13,26 +13,36 @@ function New-VSGuardDutyThreatIntelSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Format + The format of the file that contains the ThreatIntelSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-format PrimitiveType: String UpdateType: Immutable .PARAMETER Activate + Specifies whether or not GuardDuty uses the ThreatIntelSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-activate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DetectorId + The ID of the detector to associate the ThreatIntelSet with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-detectorid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + A name for the ThreatIntelSet. The name is displayed in all finding generated by activity associated with the IP addresses included in this ThreatIntelSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-name PrimitiveType: String UpdateType: Mutable .PARAMETER Location + The URI of the file that contains the ThreatIntelSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 b/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 index eb5b08d1c..6e8c5319c 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 @@ -1,10 +1,18 @@ function New-VSIAMAccessKey { <# .SYNOPSIS - Adds an AWS::IAM::AccessKey resource to the template. + Adds an AWS::IAM::AccessKey resource to the template. Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active. .DESCRIPTION - Adds an AWS::IAM::AccessKey resource to the template. + Adds an AWS::IAM::AccessKey resource to the template. Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active. + +If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users. + +For information about limits on the number of keys you can create, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. + +**Important** + +To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html @@ -13,16 +21,23 @@ function New-VSIAMAccessKey { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Serial + This value is specific to CloudFormation and can only be *incremented*. Incrementing this value notifies CloudFormation that you want to rotate your access key. When you update your stack, CloudFormation will replace the existing access key with a new key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-serial PrimitiveType: Integer UpdateType: Immutable .PARAMETER Status + The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-status PrimitiveType: String UpdateType: Mutable .PARAMETER UserName + The name of the IAM user that the new key will belong to. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-username PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 b/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 index fa31f6a43..5b3604828 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 @@ -1,10 +1,12 @@ function New-VSIAMGroup { <# .SYNOPSIS - Adds an AWS::IAM::Group resource to the template. + Adds an AWS::IAM::Group resource to the template. Creates a new group. .DESCRIPTION - Adds an AWS::IAM::Group resource to the template. + Adds an AWS::IAM::Group resource to the template. Creates a new group. + +For information about the number of groups you can create, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html @@ -13,11 +15,20 @@ function New-VSIAMGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GroupName + The name of the group to create. Do not include the path in this value. +The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the group name. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. +If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities. +Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": "", {"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-groupname PrimitiveType: String UpdateType: Immutable .PARAMETER ManagedPolicyArns + The Amazon Resource Name ARN of the IAM policy you want to attach. +For more information about ARNs, see Amazon Resource Names ARNs and AWS Service Namespaces: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html in the *AWS General Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-managepolicyarns DuplicatesAllowed: False PrimitiveItemType: String @@ -25,11 +36,19 @@ function New-VSIAMGroup { UpdateType: Mutable .PARAMETER Path + The path to the group. For more information about paths, see IAM Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html in the *IAM User Guide*. +This parameter is optional. If it is not included, it defaults to a slash /. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of either a forward slash / by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! u0021 through the DEL character u007F, including most punctuation characters, digits, and upper and lowercased letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-path PrimitiveType: String UpdateType: Mutable .PARAMETER Policies + Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see Declaring an IAM Group Resource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group. +The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. +For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-policies DuplicatesAllowed: False ItemType: Policy diff --git a/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 b/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 index 98869b89b..40a43e5e1 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 @@ -1,10 +1,12 @@ function New-VSIAMInstanceProfile { <# .SYNOPSIS - Adds an AWS::IAM::InstanceProfile resource to the template. + Adds an AWS::IAM::InstanceProfile resource to the template. Creates a new instance profile. For information about instance profiles, go to About Instance Profiles: https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html. .DESCRIPTION - Adds an AWS::IAM::InstanceProfile resource to the template. + Adds an AWS::IAM::InstanceProfile resource to the template. Creates a new instance profile. For information about instance profiles, go to About Instance Profiles: https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html. + +For information about the number of instance profiles you can create, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html @@ -13,16 +15,25 @@ function New-VSIAMInstanceProfile { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InstanceProfileName + The name of the instance profile to create. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-instanceprofilename PrimitiveType: String UpdateType: Immutable .PARAMETER Path + The path to the instance profile. For more information about paths, see IAM Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html in the *IAM User Guide*. +This parameter is optional. If it is not included, it defaults to a slash /. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of either a forward slash / by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! u0021 through the DEL character u007F, including most punctuation characters, digits, and upper and lowercased letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-path PrimitiveType: String UpdateType: Immutable .PARAMETER Roles + The role associated with the instance profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-roles DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 index 99a83be33..33d7ccbbd 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 @@ -1,10 +1,14 @@ function New-VSIAMManagedPolicy { <# .SYNOPSIS - Adds an AWS::IAM::ManagedPolicy resource to the template. + Adds an AWS::IAM::ManagedPolicy resource to the template. Creates a new managed policy for your AWS account. .DESCRIPTION - Adds an AWS::IAM::ManagedPolicy resource to the template. + Adds an AWS::IAM::ManagedPolicy resource to the template. Creates a new managed policy for your AWS account. + +This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html in the *IAM User Guide*. + +For more information about managed policies in general, see Managed Policies and Inline Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html in the *IAM User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html @@ -13,11 +17,18 @@ function New-VSIAMManagedPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A friendly description of the policy. +Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." +The policy description is immutable. After a value is assigned, it cannot be changed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-description PrimitiveType: String UpdateType: Immutable .PARAMETER Groups + The name friendly name, not ARN of the group to attach the policy to. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-groups DuplicatesAllowed: False PrimitiveItemType: String @@ -25,21 +36,42 @@ function New-VSIAMManagedPolicy { UpdateType: Mutable .PARAMETER ManagedPolicyName + The friendly name of the policy. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. +If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities. +Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": "", {"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-managedpolicyname PrimitiveType: String UpdateType: Immutable .PARAMETER Path + The path for the policy. +For more information about paths, see IAM Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html in the *IAM User Guide*. +This parameter is optional. If it is not included, it defaults to a slash /. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of either a forward slash / by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! u0021 through the DEL character u007F, including most punctuation characters, digits, and upper and lowercased letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-ec2-dhcpoptions-path PrimitiveType: String UpdateType: Immutable .PARAMETER PolicyDocument + The JSON policy document that you want to use as the content for the new policy. +You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. +The regex pattern: http://wikipedia.org/wiki/regex used to validate this parameter is a string of characters consisting of the following: ++ Any printable ASCII character ranging from the space character u0020 through the end of the ASCII character range ++ The printable characters in the Basic Latin and Latin-1 Supplement character set through u00FF ++ The special characters tab u0009, line feed u000A, and carriage return u000D + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER Roles + The name friendly name, not ARN of the role to attach the policy to. +This parameter allows per its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- +If an external policy such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy has a Ref to a role and if a resource such as AWS::ECS::Service also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-roles DuplicatesAllowed: True PrimitiveItemType: String @@ -47,6 +79,9 @@ function New-VSIAMManagedPolicy { UpdateType: Mutable .PARAMETER Users + The name friendly name, not ARN of the IAM user to attach the policy to. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-users DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 index 90df4960e..6b65f2abd 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 @@ -1,10 +1,16 @@ function New-VSIAMPolicy { <# .SYNOPSIS - Adds an AWS::IAM::Policy resource to the template. + Adds an AWS::IAM::Policy resource to the template. Adds or updates an inline policy document that is embedded in the specified IAM user, group, or role. .DESCRIPTION - Adds an AWS::IAM::Policy resource to the template. + Adds an AWS::IAM::Policy resource to the template. Adds or updates an inline policy document that is embedded in the specified IAM user, group, or role. + +An IAM user can also have a managed policy attached to it. For information about policies, see Managed Policies and Inline Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html in the *IAM User Guide*. + +The Groups, Roles, and Users properties are optional. However, you must specify at least one of these properties. + +For information about limits on the number of inline policies that you can embed in an identity, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html @@ -13,6 +19,9 @@ function New-VSIAMPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Groups + The name of the group to associate the policy with. +®ex-name;. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-groups DuplicatesAllowed: True PrimitiveItemType: String @@ -20,16 +29,30 @@ function New-VSIAMPolicy { UpdateType: Mutable .PARAMETER PolicyDocument + The policy document. +You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. +The regex pattern: http://wikipedia.org/wiki/regex used to validate this parameter is a string of characters consisting of the following: ++ Any printable ASCII character ranging from the space character u0020 through the end of the ASCII character range ++ The printable characters in the Basic Latin and Latin-1 Supplement character set through u00FF ++ The special characters tab u0009, line feed u000A, and carriage return u000D + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER PolicyName + The name of the policy document. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policyname PrimitiveType: String UpdateType: Mutable .PARAMETER Roles + The name of the role to associate the policy with. +This parameter allows per its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- +If an external policy such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy has a Ref to a role and if a resource such as AWS::ECS::Service also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-roles DuplicatesAllowed: True PrimitiveItemType: String @@ -37,6 +60,9 @@ function New-VSIAMPolicy { UpdateType: Mutable .PARAMETER Users + The name of the user to associate the policy with. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-users DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 b/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 index 02d0c146b..088539174 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 @@ -1,10 +1,10 @@ function New-VSIAMRole { <# .SYNOPSIS - Adds an AWS::IAM::Role resource to the template. + Adds an AWS::IAM::Role resource to the template. Creates a new role for your AWS account. For more information about roles, go to IAM Roles: https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. .DESCRIPTION - Adds an AWS::IAM::Role resource to the template. + Adds an AWS::IAM::Role resource to the template. Creates a new role for your AWS account. For more information about roles, go to IAM Roles: https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html @@ -13,16 +13,23 @@ function New-VSIAMRole { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssumeRolePolicyDocument + The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-templateexamples. For more information about the elements that you can use in an IAM policy, see IAM Policy Elements Reference: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER Description + A description of the role that you provide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-description PrimitiveType: String UpdateType: Mutable .PARAMETER ManagedPolicyArns + A list of Amazon Resource Names ARNs of the IAM managed policies that you want to attach to the user. +For more information about ARNs, see Amazon Resource Names ARNs and AWS Service Namespaces: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html in the *AWS General Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-managepolicyarns DuplicatesAllowed: False PrimitiveItemType: String @@ -30,21 +37,37 @@ function New-VSIAMRole { UpdateType: Mutable .PARAMETER MaxSessionDuration + The maximum session duration in seconds that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. +Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-maxsessionduration PrimitiveType: Integer UpdateType: Mutable .PARAMETER Path + The path to the role. For more information about paths, see IAM Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html in the *IAM User Guide*. +This parameter is optional. If it is not included, it defaults to a slash /. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of either a forward slash / by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! u0021 through the DEL character u007F, including most punctuation characters, digits, and upper and lowercased letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path PrimitiveType: String UpdateType: Immutable .PARAMETER PermissionsBoundary + The ARN of the policy used to set the permissions boundary for the role. +For more information about permissions boundaries, see Permissions Boundaries for IAM Identities : https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary PrimitiveType: String UpdateType: Mutable .PARAMETER Policies + Adds or updates an inline policy document that is embedded in the specified IAM role. +When you embed an inline policy in a role, the inline policy is used as part of the role's access permissions policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html. +A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html in the *IAM User Guide*. +For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. +If an external policy such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy has a Ref to a role and if a resource such as AWS::ECS::Service also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies DuplicatesAllowed: True ItemType: Policy @@ -52,11 +75,19 @@ function New-VSIAMRole { UpdateType: Mutable .PARAMETER RoleName + A name for the IAM role. For valid values, see the RoleName parameter for the CreateRole : https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html action in the *IAM User Guide*. +This parameter allows per its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". +If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name. +If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities. +Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": "", {"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-rolename PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 b/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 index 115131b2f..046c555d1 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 @@ -1,10 +1,12 @@ function New-VSIAMServiceLinkedRole { <# .SYNOPSIS - Adds an AWS::IAM::ServiceLinkedRole resource to the template. + Adds an AWS::IAM::ServiceLinkedRole resource to the template. Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using Service-Linked Roles: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html in the *IAM User Guide*. .DESCRIPTION - Adds an AWS::IAM::ServiceLinkedRole resource to the template. + Adds an AWS::IAM::ServiceLinkedRole resource to the template. Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using Service-Linked Roles: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html in the *IAM User Guide*. + +To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html @@ -13,16 +15,24 @@ function New-VSIAMServiceLinkedRole { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CustomSuffix + A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix. +Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-customsuffix PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of the role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-description PrimitiveType: String UpdateType: Mutable .PARAMETER AWSServiceName + The service principal for the AWS service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com. +Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see AWS Services That Work with IAM: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html in the *IAM User Guide*. Look for the services that have **Yes **in the **Service-Linked Role** column. Choose the **Yes** link to view the service-linked role documentation for that service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-awsservicename PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 b/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 index d4e5db81d..b5814a7c6 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 @@ -1,10 +1,12 @@ function New-VSIAMUser { <# .SYNOPSIS - Adds an AWS::IAM::User resource to the template. + Adds an AWS::IAM::User resource to the template. Creates a new IAM user for your AWS account. .DESCRIPTION - Adds an AWS::IAM::User resource to the template. + Adds an AWS::IAM::User resource to the template. Creates a new IAM user for your AWS account. + +For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html @@ -13,6 +15,8 @@ function New-VSIAMUser { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Groups + A list of groups to which you want to add the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-groups DuplicatesAllowed: True PrimitiveItemType: String @@ -20,11 +24,16 @@ function New-VSIAMUser { UpdateType: Mutable .PARAMETER LoginProfile + Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-loginprofile Type: LoginProfile UpdateType: Mutable .PARAMETER ManagedPolicyArns + A list of Amazon Resource Names ARNs of the IAM managed policies that you want to attach to the user. +For more information about ARNs, see Amazon Resource Names ARNs and AWS Service Namespaces: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html in the *AWS General Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-managepolicyarns DuplicatesAllowed: False PrimitiveItemType: String @@ -32,16 +41,26 @@ function New-VSIAMUser { UpdateType: Mutable .PARAMETER Path + The path for the user name. For more information about paths, see IAM Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html in the *IAM User Guide*. +This parameter is optional. If it is not included, it defaults to a slash /. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of either a forward slash / by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! u0021 through the DEL character u007F, including most punctuation characters, digits, and upper and lowercased letters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-path PrimitiveType: String UpdateType: Mutable .PARAMETER PermissionsBoundary + The ARN of the policy that is used to set the permissions boundary for the user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-permissionsboundary PrimitiveType: String UpdateType: Mutable .PARAMETER Policies + Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see Declaring an IAM User Resource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user. +The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. +For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities: https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html in the *IAM User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-policies DuplicatesAllowed: True ItemType: Policy @@ -49,6 +68,8 @@ function New-VSIAMUser { UpdateType: Mutable .PARAMETER Tags + + CreateUser: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateUser.html in the *AWS Identity and Access Management API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-tags DuplicatesAllowed: True ItemType: Tag @@ -56,6 +77,12 @@ function New-VSIAMUser { UpdateType: Mutable .PARAMETER UserName + The name of the user to create. Do not include the path in this value. +This parameter allows per its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". +If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name. +If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities. +Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": "", {"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-username PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 b/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 index 6faa53ddb..6388071b9 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 @@ -1,10 +1,10 @@ function New-VSIAMUserToGroupAddition { <# .SYNOPSIS - Adds an AWS::IAM::UserToGroupAddition resource to the template. + Adds an AWS::IAM::UserToGroupAddition resource to the template. Adds the specified user to the specified group. .DESCRIPTION - Adds an AWS::IAM::UserToGroupAddition resource to the template. + Adds an AWS::IAM::UserToGroupAddition resource to the template. Adds the specified user to the specified group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html @@ -13,11 +13,16 @@ function New-VSIAMUserToGroupAddition { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GroupName + The name of the group to update. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html#cfn-iam-addusertogroup-groupname PrimitiveType: String UpdateType: Mutable .PARAMETER Users + A list of the names of the users that you want to add to the group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html#cfn-iam-addusertogroup-users DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 index 08a3ecedc..33d58a1f7 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 @@ -1,10 +1,10 @@ function New-VSInspectorAssessmentTarget { <# .SYNOPSIS - Adds an AWS::Inspector::AssessmentTarget resource to the template. + Adds an AWS::Inspector::AssessmentTarget resource to the template. The AWS::Inspector::AssessmentTarget resource is used to create Amazon Inspector assessment targets, which specify the Amazon EC2 instances that will be analyzed during an assessment run. .DESCRIPTION - Adds an AWS::Inspector::AssessmentTarget resource to the template. + Adds an AWS::Inspector::AssessmentTarget resource to the template. The AWS::Inspector::AssessmentTarget resource is used to create Amazon Inspector assessment targets, which specify the Amazon EC2 instances that will be analyzed during an assessment run. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html @@ -13,11 +13,15 @@ function New-VSInspectorAssessmentTarget { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssessmentTargetName + The name of the Amazon Inspector assessment target. The name must be unique within the AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#cfn-inspector-assessmenttarget-assessmenttargetname PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceGroupArn + The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and Region are included in the assessment target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#cfn-inspector-assessmenttarget-resourcegrouparn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 index 74e852c8d..729317048 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSInspectorAssessmentTemplate { <# .SYNOPSIS - Adds an AWS::Inspector::AssessmentTemplate resource to the template. + Adds an AWS::Inspector::AssessmentTemplate resource to the template. The AWS::Inspector::AssessmentTemplate resource creates an Amazon Inspector assessment template, which specifies the Inspector assessment targets that will be evaluated by an assessment run and its related configurations. .DESCRIPTION - Adds an AWS::Inspector::AssessmentTemplate resource to the template. + Adds an AWS::Inspector::AssessmentTemplate resource to the template. The AWS::Inspector::AssessmentTemplate resource creates an Amazon Inspector assessment template, which specifies the Inspector assessment targets that will be evaluated by an assessment run and its related configurations. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html @@ -13,27 +13,37 @@ function New-VSInspectorAssessmentTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssessmentTargetArn + The ARN of the assessment target to be included in the assessment template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttargetarn PrimitiveType: String UpdateType: Immutable .PARAMETER DurationInSeconds + The duration of the assessment run in seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-durationinseconds PrimitiveType: Integer UpdateType: Immutable .PARAMETER AssessmentTemplateName + The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for the same assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttemplatename PrimitiveType: String UpdateType: Immutable .PARAMETER RulesPackageArns + The ARNs of the rules packages that you want to use in the assessment template. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-rulespackagearns UpdateType: Immutable .PARAMETER UserAttributesForFindings + The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. Within an assessment template, each key must be unique. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-userattributesforfindings ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 index e404fd326..bf34f2d9d 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 @@ -1,10 +1,10 @@ function New-VSInspectorResourceGroup { <# .SYNOPSIS - Adds an AWS::Inspector::ResourceGroup resource to the template. + Adds an AWS::Inspector::ResourceGroup resource to the template. The AWS::Inspector::ResourceGroup resource is used to create Amazon Inspector resource groups. A resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. .DESCRIPTION - Adds an AWS::Inspector::ResourceGroup resource to the template. + Adds an AWS::Inspector::ResourceGroup resource to the template. The AWS::Inspector::ResourceGroup resource is used to create Amazon Inspector resource groups. A resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html @@ -13,6 +13,9 @@ function New-VSInspectorResourceGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResourceGroupTags + The tags key and value pairs that will be associated with the resource group. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html#cfn-inspector-resourcegroup-resourcegrouptags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 b/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 index 88b2203a7..4fc0cb5f7 100644 --- a/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 @@ -1,10 +1,10 @@ function New-VSIoT1ClickDevice { <# .SYNOPSIS - Adds an AWS::IoT1Click::Device resource to the template. + Adds an AWS::IoT1Click::Device resource to the template. The AWS::IoT1Click::Device resource controls the enabled state of an AWS IoT 1-Click compatible device. For more information, see Device: https://docs.aws.amazon.com/iot-1-click/1.0/devices-apireference/devices-deviceid.html in the *AWS IoT 1-Click Devices API Reference*. .DESCRIPTION - Adds an AWS::IoT1Click::Device resource to the template. + Adds an AWS::IoT1Click::Device resource to the template. The AWS::IoT1Click::Device resource controls the enabled state of an AWS IoT 1-Click compatible device. For more information, see Device: https://docs.aws.amazon.com/iot-1-click/1.0/devices-apireference/devices-deviceid.html in the *AWS IoT 1-Click Devices API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-device.html @@ -13,11 +13,15 @@ function New-VSIoT1ClickDevice { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeviceId + The ID of the device, such as G030PX0312744DWM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-device.html#cfn-iot1click-device-deviceid PrimitiveType: String UpdateType: Immutable .PARAMETER Enabled + A Boolean value indicating whether the device is enabled true or not false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-device.html#cfn-iot1click-device-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 b/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 index 14c7b6640..b77171c53 100644 --- a/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 @@ -1,10 +1,10 @@ function New-VSIoT1ClickPlacement { <# .SYNOPSIS - Adds an AWS::IoT1Click::Placement resource to the template. + Adds an AWS::IoT1Click::Placement resource to the template. The AWS::IoT1Click::Placement resource creates a placement to be associated with an AWS IoT 1-Click project. A placement is an instance of a device in a location. For more information, see Projects, Templates, and Placements: https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-PTP.html in the *AWS IoT 1-Click Developer Guide*. .DESCRIPTION - Adds an AWS::IoT1Click::Placement resource to the template. + Adds an AWS::IoT1Click::Placement resource to the template. The AWS::IoT1Click::Placement resource creates a placement to be associated with an AWS IoT 1-Click project. A placement is an instance of a device in a location. For more information, see Projects, Templates, and Placements: https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-PTP.html in the *AWS IoT 1-Click Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html @@ -13,21 +13,29 @@ function New-VSIoT1ClickPlacement { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PlacementName + The name of the placement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-placementname PrimitiveType: String UpdateType: Immutable .PARAMETER ProjectName + The name of the project containing the placement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-projectname PrimitiveType: String UpdateType: Immutable .PARAMETER AssociatedDevices + The devices to associate with the placement, as defined by a mapping of zero or more key-value pairs wherein the key is a template name and the value is a device ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-associateddevices PrimitiveType: Json UpdateType: Immutable .PARAMETER Attributes + The user-defined attributes associated with the placement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-attributes PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 b/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 index f9a58c6c0..bc22dbd13 100644 --- a/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 @@ -1,10 +1,10 @@ function New-VSIoT1ClickProject { <# .SYNOPSIS - Adds an AWS::IoT1Click::Project resource to the template. + Adds an AWS::IoT1Click::Project resource to the template. The AWS::IoT1Click::Project resource creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject: https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_CreateProject.html in the *AWS IoT 1-Click Projects API Reference*. .DESCRIPTION - Adds an AWS::IoT1Click::Project resource to the template. + Adds an AWS::IoT1Click::Project resource to the template. The AWS::IoT1Click::Project resource creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject: https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_CreateProject.html in the *AWS IoT 1-Click Projects API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html @@ -13,16 +13,22 @@ function New-VSIoT1ClickProject { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the project. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html#cfn-iot1click-project-description PrimitiveType: String UpdateType: Mutable .PARAMETER PlacementTemplate + An object describing the project's placement specifications. + Type: PlacementTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html#cfn-iot1click-project-placementtemplate UpdateType: Mutable .PARAMETER ProjectName + The name of the project from which to obtain information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html#cfn-iot1click-project-projectname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 index 0995344e8..9e4e28b2b 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 @@ -1,10 +1,10 @@ function New-VSIoTAnalyticsChannel { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Channel resource to the template. + Adds an AWS::IoTAnalytics::Channel resource to the template. The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .DESCRIPTION - Adds an AWS::IoTAnalytics::Channel resource to the template. + Adds an AWS::IoTAnalytics::Channel resource to the template. The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html @@ -13,21 +13,30 @@ function New-VSIoTAnalyticsChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ChannelName + The name of the channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelname PrimitiveType: String UpdateType: Immutable .PARAMETER ChannelStorage + Where channel data is stored. + Type: ChannelStorage Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelstorage UpdateType: Mutable .PARAMETER RetentionPeriod + How long, in days, message data is kept for the channel. + Type: RetentionPeriod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-retentionperiod UpdateType: Mutable .PARAMETER Tags + Metadata which can be used to manage the channel. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 index 517d0206d..83bef984f 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 @@ -1,10 +1,10 @@ function New-VSIoTAnalyticsDataset { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset resource to the template. + Adds an AWS::IoTAnalytics::Dataset resource to the template. The AWS::IoTAnalytics::Dataset resource stores data retrieved from a data store by applying a "queryAction" (an SQL query or a "containerAction" (executing a containerized application. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .DESCRIPTION - Adds an AWS::IoTAnalytics::Dataset resource to the template. + Adds an AWS::IoTAnalytics::Dataset resource to the template. The AWS::IoTAnalytics::Dataset resource stores data retrieved from a data store by applying a "queryAction" (an SQL query or a "containerAction" (executing a containerized application. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html @@ -13,39 +13,54 @@ function New-VSIoTAnalyticsDataset { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Actions + The "DatasetAction" objects that automatically create the data set contents. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-actions ItemType: Action UpdateType: Mutable .PARAMETER DatasetName + The name of the data set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-datasetname PrimitiveType: String UpdateType: Immutable .PARAMETER ContentDeliveryRules + When data set contents are created they are delivered to destinations specified here. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-contentdeliveryrules ItemType: DatasetContentDeliveryRule UpdateType: Mutable .PARAMETER Triggers + The "DatasetTrigger" objects that specify when the data set is automatically updated. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-triggers ItemType: Trigger UpdateType: Mutable .PARAMETER VersioningConfiguration + Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version if they are different are kept for the time period specified by the "retentionPeriod" parameter. For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions + Type: VersioningConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-versioningconfiguration UpdateType: Mutable .PARAMETER RetentionPeriod + Optional] How long, in days, message data is kept for the data set. + Type: RetentionPeriod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-retentionperiod UpdateType: Mutable .PARAMETER Tags + Metadata which can be used to manage the data set. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 index 207dc90fc..fb6b441bb 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 @@ -1,10 +1,10 @@ function New-VSIoTAnalyticsDatastore { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Datastore resource to the template. + Adds an AWS::IoTAnalytics::Datastore resource to the template. AWS::IoTAnalytics::Datastore resource is a repository for messages. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .DESCRIPTION - Adds an AWS::IoTAnalytics::Datastore resource to the template. + Adds an AWS::IoTAnalytics::Datastore resource to the template. AWS::IoTAnalytics::Datastore resource is a repository for messages. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html @@ -13,21 +13,30 @@ function New-VSIoTAnalyticsDatastore { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DatastoreStorage + Where data store data is stored. + Type: DatastoreStorage Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorestorage UpdateType: Mutable .PARAMETER DatastoreName + The name of the data store. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorename PrimitiveType: String UpdateType: Immutable .PARAMETER RetentionPeriod + How long, in days, message data is kept for the data store. When "customerManagedS3" storage is selected, this parameter is ignored. + Type: RetentionPeriod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-retentionperiod UpdateType: Mutable .PARAMETER Tags + Metadata which can be used to manage the data store. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 index 0e71a06c9..92ea060d9 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 @@ -1,10 +1,10 @@ function New-VSIoTAnalyticsPipeline { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline resource to the template. + Adds an AWS::IoTAnalytics::Pipeline resource to the template. The AWS::IoTAnalytics::Pipeline resource consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .DESCRIPTION - Adds an AWS::IoTAnalytics::Pipeline resource to the template. + Adds an AWS::IoTAnalytics::Pipeline resource to the template. The AWS::IoTAnalytics::Pipeline resource consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. For more information, see How to Use AWS IoT Analytics: https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how in the *AWS IoT Analytics User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html @@ -13,17 +13,26 @@ function New-VSIoTAnalyticsPipeline { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PipelineName + The name of the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelinename PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Metadata which can be used to manage the pipeline. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-tags ItemType: Tag UpdateType: Mutable .PARAMETER PipelineActivities + A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. +The list can be 2-25 **PipelineActivity** objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example: +pipelineActivities = { "channel": { ... } }, { "lambda": { ... } }, ... ] + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelineactivities ItemType: Activity diff --git a/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 index f213e4945..6962a4e90 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 @@ -1,10 +1,10 @@ function New-VSIoTCertificate { <# .SYNOPSIS - Adds an AWS::IoT::Certificate resource to the template. + Adds an AWS::IoT::Certificate resource to the template. Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see Authentication in AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/x509-certs.html in the *AWS IoT Developer Guide*. .DESCRIPTION - Adds an AWS::IoT::Certificate resource to the template. + Adds an AWS::IoT::Certificate resource to the template. Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see Authentication in AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/x509-certs.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html @@ -13,11 +13,16 @@ function New-VSIoTCertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CertificateSigningRequest + The certificate signing request CSR. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-certificatesigningrequest PrimitiveType: String UpdateType: Immutable .PARAMETER Status + The status of the certificate. +The status value REGISTER_INACTIVE is deprecated and should not be used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-status PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 b/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 index 64c7c280f..9e2c8ae44 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 @@ -1,10 +1,20 @@ function New-VSIoTEventsDetectorModel { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel resource to the template. + Adds an AWS::IoTEvents::DetectorModel resource to the template. The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process using *states*. For each state, you define conditional (Boolean logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see How to Use AWS IoT Events: https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html in the *AWS IoT Events Developer Guide*. .DESCRIPTION - Adds an AWS::IoTEvents::DetectorModel resource to the template. + Adds an AWS::IoTEvents::DetectorModel resource to the template. The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process using *states*. For each state, you define conditional (Boolean logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see How to Use AWS IoT Events: https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html in the *AWS IoT Events Developer Guide*. + +**Note** + +When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or AWS CloudFormation all detector instances created by the model are reset to their initial states. (The detector's state, and the values of any variables and timers are reset. + +When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or AWS CloudFormation the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds. + +If you attempt to update a detector model using AWS CloudFormation and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3 and the detector instances are reset. + +Also, be aware that if you attempt to update several detector models at once using AWS CloudFormation, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html @@ -13,36 +23,51 @@ function New-VSIoTEventsDetectorModel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DetectorModelDefinition + Information that defines how a detector operates. + Type: DetectorModelDefinition Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition UpdateType: Mutable .PARAMETER EvaluationMethod + + CreateDetectorModel: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html in the *AWS IoT Events API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER DetectorModelName + The name of the detector model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodelname PrimitiveType: String UpdateType: Immutable .PARAMETER DetectorModelDescription + A brief description of the detector model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldescription PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The input attribute key used to identify a device or system to create a detector an instance of the detector model and then to route each input received to the appropriate detector instance. This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn + The ARN of the role that grants permission to AWS IoT Events to perform its operations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 b/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 index 3b8b73fdb..7e4ea80c1 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 @@ -1,10 +1,10 @@ function New-VSIoTEventsInput { <# .SYNOPSIS - Adds an AWS::IoTEvents::Input resource to the template. + Adds an AWS::IoTEvents::Input resource to the template. The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see How to Use AWS IoT Events: https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html in the *AWS IoT Events Developer Guide*. .DESCRIPTION - Adds an AWS::IoTEvents::Input resource to the template. + Adds an AWS::IoTEvents::Input resource to the template. The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see How to Use AWS IoT Events: https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html in the *AWS IoT Events Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html @@ -13,21 +13,30 @@ function New-VSIoTEventsInput { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InputDefinition + The definition of the input. + Type: InputDefinition Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputdefinition UpdateType: Mutable .PARAMETER InputName + The name of the input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputname PrimitiveType: String UpdateType: Immutable .PARAMETER InputDescription + A brief description of the input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputdescription PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 index 340a45ef0..6e08590ee 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 @@ -1,10 +1,10 @@ function New-VSIoTPolicy { <# .SYNOPSIS - Adds an AWS::IoT::Policy resource to the template. + Adds an AWS::IoT::Policy resource to the template. Use the AWS::IoT::Policy resource to declare an AWS IoT policy. For more information about working with AWS IoT policies, see Authorization: https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html in the *AWS IoT Developer Guide*. .DESCRIPTION - Adds an AWS::IoT::Policy resource to the template. + Adds an AWS::IoT::Policy resource to the template. Use the AWS::IoT::Policy resource to declare an AWS IoT policy. For more information about working with AWS IoT policies, see Authorization: https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html @@ -13,11 +13,15 @@ function New-VSIoTPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PolicyDocument + The JSON document that describes the policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policydocument PrimitiveType: Json UpdateType: Immutable .PARAMETER PolicyName + The policy name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policyname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 index 62052863c..a6ad53707 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 @@ -1,10 +1,12 @@ function New-VSIoTPolicyPrincipalAttachment { <# .SYNOPSIS - Adds an AWS::IoT::PolicyPrincipalAttachment resource to the template. + Adds an AWS::IoT::PolicyPrincipalAttachment resource to the template. Use the AWS::IoT::PolicyPrincipalAttachment resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential. .DESCRIPTION - Adds an AWS::IoT::PolicyPrincipalAttachment resource to the template. + Adds an AWS::IoT::PolicyPrincipalAttachment resource to the template. Use the AWS::IoT::PolicyPrincipalAttachment resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential. + +For information about working with AWS IoT policies and principals, see Authorization: https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html @@ -13,11 +15,15 @@ function New-VSIoTPolicyPrincipalAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PolicyName + The name of the AWS IoT policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html#cfn-iot-policyprincipalattachment-policyname PrimitiveType: String UpdateType: Immutable .PARAMETER Principal + The principal, which can be a certificate ARN as returned from the CreateCertificate operation or an Amazon Cognito ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html#cfn-iot-policyprincipalattachment-principal PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 b/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 index ae9f612f0..7551a1fc1 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 @@ -1,10 +1,12 @@ function New-VSIoTThing { <# .SYNOPSIS - Adds an AWS::IoT::Thing resource to the template. + Adds an AWS::IoT::Thing resource to the template. Use the AWS::IoT::Thing resource to declare an AWS IoT thing. .DESCRIPTION - Adds an AWS::IoT::Thing resource to the template. + Adds an AWS::IoT::Thing resource to the template. Use the AWS::IoT::Thing resource to declare an AWS IoT thing. + +For information about working with things, see How AWS IoT Works: https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html and Device Registry for AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html @@ -13,11 +15,15 @@ function New-VSIoTThing { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AttributePayload + A string that contains up to three key–value pairs. Maximum length of 800. Duplicates not allowed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-attributepayload Type: AttributePayload UpdateType: Mutable .PARAMETER ThingName + The name of the thing to update. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-thingname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 index 221d2f4a2..2603aca0e 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 @@ -1,10 +1,12 @@ function New-VSIoTThingPrincipalAttachment { <# .SYNOPSIS - Adds an AWS::IoT::ThingPrincipalAttachment resource to the template. + Adds an AWS::IoT::ThingPrincipalAttachment resource to the template. Use the AWS::IoT::ThingPrincipalAttachment resource to attach a principal (an X.509 certificate or another credential to a thing. .DESCRIPTION - Adds an AWS::IoT::ThingPrincipalAttachment resource to the template. + Adds an AWS::IoT::ThingPrincipalAttachment resource to the template. Use the AWS::IoT::ThingPrincipalAttachment resource to attach a principal (an X.509 certificate or another credential to a thing. + +For more information about working with AWS IoT things and principals, see Authorization: https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html @@ -13,11 +15,15 @@ function New-VSIoTThingPrincipalAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Principal + The principal, which can be a certificate ARN as returned from the CreateCertificate operation or an Amazon Cognito ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html#cfn-iot-thingprincipalattachment-principal PrimitiveType: String UpdateType: Immutable .PARAMETER ThingName + The name of the AWS IoT thing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html#cfn-iot-thingprincipalattachment-thingname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 index 527b433e3..205ca6f5d 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSIoTThingsGraphFlowTemplate { <# .SYNOPSIS - Adds an AWS::IoTThingsGraph::FlowTemplate resource to the template. + Adds an AWS::IoTThingsGraph::FlowTemplate resource to the template. Represents a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities. The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request. .DESCRIPTION - Adds an AWS::IoTThingsGraph::FlowTemplate resource to the template. + Adds an AWS::IoTThingsGraph::FlowTemplate resource to the template. Represents a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities. The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotthingsgraph-flowtemplate.html @@ -13,11 +13,15 @@ function New-VSIoTThingsGraphFlowTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CompatibleNamespaceVersion + The version of the user's namespace against which the workflow was validated. Use this value in your system instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotthingsgraph-flowtemplate.html#cfn-iotthingsgraph-flowtemplate-compatiblenamespaceversion PrimitiveType: Double UpdateType: Mutable .PARAMETER Definition + A workflow's definition document. + Type: DefinitionDocument Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotthingsgraph-flowtemplate.html#cfn-iotthingsgraph-flowtemplate-definition UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 b/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 index 80ea2d9a5..22da7b2cb 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 @@ -1,10 +1,10 @@ function New-VSIoTTopicRule { <# .SYNOPSIS - Adds an AWS::IoT::TopicRule resource to the template. + Adds an AWS::IoT::TopicRule resource to the template. Use the AWS::IoT::TopicRule resource to declare an AWS IoT rule. For information about working with AWS IoT rules, see Rules for AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html in the *AWS IoT Developer Guide*. .DESCRIPTION - Adds an AWS::IoT::TopicRule resource to the template. + Adds an AWS::IoT::TopicRule resource to the template. Use the AWS::IoT::TopicRule resource to declare an AWS IoT rule. For information about working with AWS IoT rules, see Rules for AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html @@ -13,11 +13,15 @@ function New-VSIoTTopicRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RuleName + The name of the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-rulename PrimitiveType: String UpdateType: Immutable .PARAMETER TopicRulePayload + The rule payload. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-topicrulepayload Type: TopicRulePayload UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 b/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 index cb09e03be..ef2ec5916 100644 --- a/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 @@ -1,10 +1,22 @@ function New-VSKMSAlias { <# .SYNOPSIS - Adds an AWS::KMS::Alias resource to the template. + Adds an AWS::KMS::Alias resource to the template. The AWS::KMS::Alias resource specifies a display name for a customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. You can use an alias to identify a CMK in cryptographic operations. .DESCRIPTION - Adds an AWS::KMS::Alias resource to the template. + Adds an AWS::KMS::Alias resource to the template. The AWS::KMS::Alias resource specifies a display name for a customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. You can use an alias to identify a CMK in cryptographic operations. + +Using an alias to refer to a CMK can help you simplify key management. For example, an alias in your code can map to different CMKs in different AWS Regions. For more information, see Working with Aliases: https://docs.aws.amazon.com/kms/latest/developerguide/programming-aliases.html in the *AWS Key Management Service Developer Guide*. + +When specifying an alias, observe the following rules. + ++ Each alias can point to only one CMK, but multiple aliases can point to the same CMK. + ++ The alias and the CMK it points to must be in the same AWS account and Region. + ++ The alias name must be unique in the AWS account and Region. However, you can create aliases with the same name in different AWS Regions. For example, you can have an alias/projectKey in multiple Regions, each of which points to a CMK in that Region. + ++ Each alias name must begin with alias/ followed by a name, such as alias/exampleKey. The alias name can contain only alphanumeric characters, forward slashes (/, underscores (_, and dashes (-. Alias names cannot begin with **alias/aws/**. That alias name prefix is reserved for AWS managed CMKs: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html @@ -13,11 +25,15 @@ function New-VSKMSAlias { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AliasName + Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname PrimitiveType: String UpdateType: Immutable .PARAMETER TargetKeyId + Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name ARN of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn in the *AWS Key Management Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 b/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 index ab842e42e..4e1551ec9 100644 --- a/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 @@ -1,10 +1,10 @@ function New-VSKMSKey { <# .SYNOPSIS - Adds an AWS::KMS::Key resource to the template. + Adds an AWS::KMS::Key resource to the template. The AWS::KMS::Key resource specifies a customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. Authorized users can use the CMK to encrypt and decrypt small amounts of data (up to 4096 bytes, but they are more commonly used to generate data keys. You can also use CMKs to encrypt data stored in AWS services that are integrated with AWS KMS: http://aws.amazon.com/kms/features/#AWS_Service_Integration or within their applications. For more information, see What is the AWS Key Management Service?: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html in the *AWS Key Management Service Developer Guide*. .DESCRIPTION - Adds an AWS::KMS::Key resource to the template. + Adds an AWS::KMS::Key resource to the template. The AWS::KMS::Key resource specifies a customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. Authorized users can use the CMK to encrypt and decrypt small amounts of data (up to 4096 bytes, but they are more commonly used to generate data keys. You can also use CMKs to encrypt data stored in AWS services that are integrated with AWS KMS: http://aws.amazon.com/kms/features/#AWS_Service_Integration or within their applications. For more information, see What is the AWS Key Management Service?: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html in the *AWS Key Management Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html @@ -13,36 +13,63 @@ function New-VSKMSKey { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the CMK. Use a description that helps you to distinguish this CMK from others in the account, such as its intended use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description PrimitiveType: String UpdateType: Mutable .PARAMETER EnableKeyRotation + Enables automatic rotation of the key material for the specified customer master key CMK. By default, automation key rotation is not enabled. +When you enable automatic rotation, AWS KMS automatically creates new key material for the CMK 365 days after the enable or reenable date and every 365 days thereafter. AWS KMS retains all key material until you delete the CMK. +For detailed information about automatic key rotation, see Rotating Customer Master Keys: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html in the *AWS Key Management Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Enabled + Specifies whether the customer master key CMK is enabled. Disabled CMKs cannot be used in cryptographic operations. +When Enabled is true, the *key state* of the CMK is Enabled. When Enabled is false, the key state of the CMK is Disabled. The default value is true. +The actual key state of the CMK might be affected by actions taken outside of CloudFormation, such as running the EnableKey: https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html, DisableKey: https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html, or ScheduleKeyDeletion: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html operations. +For information about the key states of a CMK, see How Key State Affects Use of a Customer Master Key: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html in the *AWS Key Management Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER KeyPolicy + The key policy that authorizes use of the CMK. The key policy must observe the following rules. ++ The key policy must allow the caller to make a subsequent PutKeyPolicy: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam section of the * *AWS Key Management Service Developer Guide* *. ++ Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal for example, an IAM user or role, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency in the *AWS Identity and Access Management User Guide*. ++ The key policy size limit is 32 kilobytes 32768 bytes. +If you are unsure of which policy to use, consider the *default key policy*. This is the key policy that AWS KMS applies to CMKs that are created by using the CreateKey API with no specified key policy. It gives the AWS account that owns the key permission to perform all operations on the key. It also allows you write IAM policies to authorize access to the key. For details, see Default Key Policy: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default in the *AWS Key Management Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy PrimitiveType: Json UpdateType: Mutable .PARAMETER KeyUsage + The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage PrimitiveType: String UpdateType: Immutable .PARAMETER PendingWindowInDays + Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. +When you remove a customer master key CMK from a CloudFormation stack, AWS KMS schedules the CMK for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of CMK is Pending Deletion, which prevents the CMK from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the CMK. +You cannot use a CloudFormation template to cancel deletion of the CMK after you remove it from the stack, regardless of the waiting period. If you specify a CMK in your template, even one with the same name, CloudFormation creates a new CMK. To cancel deletion of a CMK, use the AWS KMS console or the CancelKeyDeletion: https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html operation. +For information about the PendingDeletion key state, see How Key State Affects Use of a Customer Master Key: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html in the *AWS Key Management Service Developer Guide*. For more information about deleting CMKs, see the ScheduleKeyDeletion: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html operation in the *AWS Key Management Service API Reference* and Deleting Customer Master Keys: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html in the *AWS Key Management Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 index e6fb209c0..6a8bc46dd 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 @@ -1,10 +1,10 @@ function New-VSKinesisAnalyticsApplication { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::Application resource to the template. + Adds an AWS::KinesisAnalytics::Application resource to the template. The AWS::KinesisAnalytics::Application resource creates an Amazon Kinesis Data Analytics application. For more information, see the Amazon Kinesis Data Analytics Developer Guide: /kinesisanalytics/latest/dev/what-is.html. .DESCRIPTION - Adds an AWS::KinesisAnalytics::Application resource to the template. + Adds an AWS::KinesisAnalytics::Application resource to the template. The AWS::KinesisAnalytics::Application resource creates an Amazon Kinesis Data Analytics application. For more information, see the Amazon Kinesis Data Analytics Developer Guide: /kinesisanalytics/latest/dev/what-is.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html @@ -13,22 +13,35 @@ function New-VSKinesisAnalyticsApplication { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + Name of your Amazon Kinesis Analytics application for example, sample-app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Inputs + Use this parameter to configure the application input. +You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table you can think of it as a constantly updating table. +For the streaming source, you provide its Amazon Resource Name ARN and format of data on the stream for example, JSON, CSV, etc.. You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. +To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-inputs ItemType: Input UpdateType: Mutable .PARAMETER ApplicationDescription + Summary description of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationdescription PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationCode + One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html. +You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. +Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationcode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 index a805ab3e8..f3a8ceec6 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 @@ -1,10 +1,20 @@ function New-VSKinesisAnalyticsApplicationOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationOutput resource to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput resource to the template. Adds an external destination to your Amazon Kinesis Analytics application. .DESCRIPTION - Adds an AWS::KinesisAnalytics::ApplicationOutput resource to the template. + Adds an AWS::KinesisAnalytics::ApplicationOutput resource to the template. Adds an external destination to your Amazon Kinesis Analytics application. + +If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function, you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. + +You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html. + +Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. + +For the limits on the number of application inputs and outputs you can configure, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. + +This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html @@ -13,11 +23,15 @@ function New-VSKinesisAnalyticsApplicationOutput { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + Name of the application to which you want to add the output configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Output + An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function, and record the formation to use when writing to the destination. + Type: Output Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-output UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 index b668dd137..1e87e560a 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 @@ -1,10 +1,16 @@ function New-VSKinesisAnalyticsApplicationReferenceDataSource { <# .SYNOPSIS - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource resource to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource resource to the template. Adds a reference data source to an existing application. .DESCRIPTION - Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource resource to the template. + Adds an AWS::KinesisAnalytics::ApplicationReferenceDataSource resource to the template. Adds a reference data source to an existing application. + +Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name, name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. + +For conceptual information, see Configuring Application Input: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html. For the limits on data sources you can add to your application, see Limits: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html. + +This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html @@ -13,11 +19,15 @@ function New-VSKinesisAnalyticsApplicationReferenceDataSource { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + Name of an existing application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER ReferenceDataSource + The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf. + Type: ReferenceDataSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 index c7046aac5..57398af8e 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 @@ -1,10 +1,10 @@ function New-VSKinesisAnalyticsV2Application { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application resource to the template. + Adds an AWS::KinesisAnalyticsV2::Application resource to the template. Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application: https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html. .DESCRIPTION - Adds an AWS::KinesisAnalyticsV2::Application resource to the template. + Adds an AWS::KinesisAnalyticsV2::Application resource to the template. Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application: https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html @@ -13,26 +13,36 @@ function New-VSKinesisAnalyticsV2Application { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER RuntimeEnvironment + The runtime environment for the application SQL-1.0 or FLINK-1_6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-runtimeenvironment PrimitiveType: String UpdateType: Immutable .PARAMETER ApplicationConfiguration + Use this parameter to configure the application. + Type: ApplicationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationconfiguration UpdateType: Mutable .PARAMETER ApplicationDescription + The description of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationdescription PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceExecutionRole + Specifies the IAM role that the application uses to access external resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-serviceexecutionrole PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 index e4c75e0fa..826b994fc 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 @@ -1,10 +1,10 @@ function New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption resource to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption resource to the template. Adds an Amazon CloudWatch log stream to monitor application configuration errors. .DESCRIPTION - Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption resource to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption resource to the template. Adds an Amazon CloudWatch log stream to monitor application configuration errors. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationcloudwatchloggingoption.html @@ -13,11 +13,15 @@ function New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationcloudwatchloggingoption.html#cfn-kinesisanalyticsv2-applicationcloudwatchloggingoption-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER CloudWatchLoggingOption + Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name ARN. + Type: CloudWatchLoggingOption Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationcloudwatchloggingoption.html#cfn-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 index bd0c82b66..3b3b94e14 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 @@ -1,10 +1,16 @@ function New-VSKinesisAnalyticsV2ApplicationOutput { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput resource to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput resource to the template. Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. .DESCRIPTION - Adds an AWS::KinesisAnalyticsV2::ApplicationOutput resource to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationOutput resource to the template. Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. + +If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function, you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. + +You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. + +Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication: https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_DescribeApplication.html operation to find the current application version. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html @@ -13,11 +19,15 @@ function New-VSKinesisAnalyticsV2ApplicationOutput { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html#cfn-kinesisanalyticsv2-applicationoutput-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER Output + Describes an SQL-based Amazon Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream. + Type: Output Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html#cfn-kinesisanalyticsv2-applicationoutput-output UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 index 5499f9b83..d78cf5d0f 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 @@ -1,10 +1,12 @@ function New-VSKinesisAnalyticsV2ApplicationReferenceDataSource { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource resource to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource resource to the template. Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. .DESCRIPTION - Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource resource to the template. + Adds an AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource resource to the template. Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. + +Kinesis Data Analytics reads reference data (that is, an Amazon S3 object and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name, name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html @@ -13,11 +15,15 @@ function New-VSKinesisAnalyticsV2ApplicationReferenceDataSource { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationName + The name of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-applicationname PrimitiveType: String UpdateType: Immutable .PARAMETER ReferenceDataSource + For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source by providing the source information Amazon S3 bucket name and object key name, the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table. + Type: ReferenceDataSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 index 4d73eba0b..527a82539 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 @@ -1,10 +1,10 @@ function New-VSKinesisFirehoseDeliveryStream { <# .SYNOPSIS - Adds an AWS::KinesisFirehose::DeliveryStream resource to the template. + Adds an AWS::KinesisFirehose::DeliveryStream resource to the template. The AWS::KinesisFirehose::DeliveryStream resource creates an Amazon Kinesis Data Firehose (Kinesis Data Firehose delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3, Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES destination. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream: https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html in the *Amazon Kinesis Data Firehose Developer Guide*. .DESCRIPTION - Adds an AWS::KinesisFirehose::DeliveryStream resource to the template. + Adds an AWS::KinesisFirehose::DeliveryStream resource to the template. The AWS::KinesisFirehose::DeliveryStream resource creates an Amazon Kinesis Data Firehose (Kinesis Data Firehose delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3, Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES destination. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream: https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html in the *Amazon Kinesis Data Firehose Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html @@ -13,41 +13,67 @@ function New-VSKinesisFirehoseDeliveryStream { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeliveryStreamName + The name of the delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname PrimitiveType: String UpdateType: Immutable .PARAMETER DeliveryStreamType + The delivery stream type. This can be one of the following values: ++ DirectPut: Provider applications access the delivery stream directly. ++ KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype PrimitiveType: String UpdateType: Immutable .PARAMETER ElasticsearchDestinationConfiguration + An Amazon ES destination for the delivery stream. +Conditional. You must specify only one destination configuration. +If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration Type: ElasticsearchDestinationConfiguration UpdateType: Mutable .PARAMETER ExtendedS3DestinationConfiguration + An Amazon S3 destination for the delivery stream. +Conditional. You must specify only one destination configuration. +If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration Type: ExtendedS3DestinationConfiguration UpdateType: Mutable .PARAMETER KinesisStreamSourceConfiguration + When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html containing the Kinesis stream ARN and the role ARN for the source stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration Type: KinesisStreamSourceConfiguration UpdateType: Mutable .PARAMETER RedshiftDestinationConfiguration + An Amazon Redshift destination for the delivery stream. +Conditional. You must specify only one destination configuration. +If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration Type: RedshiftDestinationConfiguration UpdateType: Mutable .PARAMETER S3DestinationConfiguration + The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service Amazon S3 destination to which Amazon Kinesis Data Firehose Kinesis Data Firehose delivers data. +Conditional. You must specify only one destination configuration. +If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration Type: S3DestinationConfiguration UpdateType: Mutable .PARAMETER SplunkDestinationConfiguration + The configuration of a destination in Splunk for the delivery stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration Type: SplunkDestinationConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 index c3a4cf0de..533282b83 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 @@ -1,10 +1,10 @@ function New-VSKinesisStream { <# .SYNOPSIS - Adds an AWS::Kinesis::Stream resource to the template. + Adds an AWS::Kinesis::Stream resource to the template. Creates a Kinesis stream that captures and transports data records that are emitted from data sources. For information about creating streams, see CreateStream: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html in the Amazon Kinesis API Reference. .DESCRIPTION - Adds an AWS::Kinesis::Stream resource to the template. + Adds an AWS::Kinesis::Stream resource to the template. Creates a Kinesis stream that captures and transports data records that are emitted from data sources. For information about creating streams, see CreateStream: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html in the Amazon Kinesis API Reference. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html @@ -13,26 +13,37 @@ function New-VSKinesisStream { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name of the Kinesis stream. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-name PrimitiveType: String UpdateType: Immutable .PARAMETER RetentionPeriodHours + The number of hours for the data records that are stored in shards to remain accessible. The default value is 24. For more information about the stream retention period, see Changing the Data Retention Period: https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html in the Amazon Kinesis Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-retentionperiodhours PrimitiveType: Integer UpdateType: Mutable .PARAMETER ShardCount + The number of shards that the stream uses. For greater provisioned throughput, increase the number of shards. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-shardcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER StreamEncryption + Enables or updates server-side encryption using an AWS KMS key for a specified stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streamencryption Type: StreamEncryption UpdateType: Mutable .PARAMETER Tags + An arbitrary set of tags key–value pairs to associate with the Kinesis stream. For information about constraints for this property, see Tag Restrictions: https://docs.aws.amazon.com/streams/latest/dev/tagging.html#tagging-restrictions in the *Amazon Kinesis Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 index cb740a2ae..c4dd9b510 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 @@ -1,10 +1,14 @@ function New-VSKinesisStreamConsumer { <# .SYNOPSIS - Adds an AWS::Kinesis::StreamConsumer resource to the template. + Adds an AWS::Kinesis::StreamConsumer resource to the template. Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream. The consumer you register can then call SubscribeToShard: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream. .DESCRIPTION - Adds an AWS::Kinesis::StreamConsumer resource to the template. + Adds an AWS::Kinesis::StreamConsumer resource to the template. Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream. The consumer you register can then call SubscribeToShard: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream. + +You can register up to five consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form: https://console.aws.amazon.com/support/v1?#/. A given consumer can only be registered with one stream at a time. + +For more information, see Using Consumers with Enhanced Fan-Out: https://docs.aws.amazon.com/streams/latest/dev/introduction-to-enhanced-consumers.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html @@ -13,11 +17,15 @@ function New-VSKinesisStreamConsumer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConsumerName + The name of the consumer is something you choose when you register the consumer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#cfn-kinesis-streamconsumer-consumername PrimitiveType: String UpdateType: Immutable .PARAMETER StreamARN + The ARN of the stream with which you registered the consumer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#cfn-kinesis-streamconsumer-streamarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 b/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 index def7a28e5..71189c6f3 100644 --- a/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 @@ -1,10 +1,10 @@ function New-VSLakeFormationDataLakeSettings { <# .SYNOPSIS - Adds an AWS::LakeFormation::DataLakeSettings resource to the template. + Adds an AWS::LakeFormation::DataLakeSettings resource to the template. The AWS::LakeFormation::DataLakeSettings resource is an AWS Lake Formation resource type that manages data lake settings. .DESCRIPTION - Adds an AWS::LakeFormation::DataLakeSettings resource to the template. + Adds an AWS::LakeFormation::DataLakeSettings resource to the template. The AWS::LakeFormation::DataLakeSettings resource is an AWS Lake Formation resource type that manages data lake settings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html @@ -13,6 +13,8 @@ function New-VSLakeFormationDataLakeSettings { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Admins + A list of AWS Lake Formation principals. + Type: Admins Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-admins UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 b/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 index a2435b3cd..59e3ed3d1 100644 --- a/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 @@ -1,10 +1,10 @@ function New-VSLakeFormationPermissions { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions resource to the template. + Adds an AWS::LakeFormation::Permissions resource to the template. The AWS::LakeFormation::Permissions resource is an AWS Lake Formation resource type that grants or revokes AWS Lake Formation permissions. .DESCRIPTION - Adds an AWS::LakeFormation::Permissions resource to the template. + Adds an AWS::LakeFormation::Permissions resource to the template. The AWS::LakeFormation::Permissions resource is an AWS Lake Formation resource type that grants or revokes AWS Lake Formation permissions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html @@ -13,22 +13,30 @@ function New-VSLakeFormationPermissions { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DataLakePrincipal + The AWS Lake Formation principal. + Type: DataLakePrincipal Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-datalakeprincipal UpdateType: Mutable .PARAMETER Resource + A structure for the resource. + Type: Resource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-resource UpdateType: Mutable .PARAMETER Permissions + The permissions granted or revoked. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-permissions UpdateType: Mutable .PARAMETER PermissionsWithGrantOption + Indicates whether to grant the ability to grant permissions as a subset of permissions granted. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-permissionswithgrantoption diff --git a/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 b/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 index 57afed83a..dee921f4e 100644 --- a/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 @@ -1,10 +1,10 @@ function New-VSLakeFormationResource { <# .SYNOPSIS - Adds an AWS::LakeFormation::Resource resource to the template. + Adds an AWS::LakeFormation::Resource resource to the template. The AWS::LakeFormation::Resource is an AWS Lake Formation resource type that defines the resources to which permissions are to be granted. .DESCRIPTION - Adds an AWS::LakeFormation::Resource resource to the template. + Adds an AWS::LakeFormation::Resource resource to the template. The AWS::LakeFormation::Resource is an AWS Lake Formation resource type that defines the resources to which permissions are to be granted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html @@ -13,16 +13,22 @@ function New-VSLakeFormationResource { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResourceArn + The Amazon Resource Name ARN of the resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-resourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER UseServiceLinkedRole + Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-useservicelinkedrole PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RoleArn + The IAM role that registered a resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 index 7d80daa61..25ae91f14 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 @@ -1,10 +1,12 @@ function New-VSLambdaAlias { <# .SYNOPSIS - Adds an AWS::Lambda::Alias resource to the template. + Adds an AWS::Lambda::Alias resource to the template. The AWS::Lambda::Alias resource creates an alias: https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. .DESCRIPTION - Adds an AWS::Lambda::Alias resource to the template. + Adds an AWS::Lambda::Alias resource to the template. The AWS::Lambda::Alias resource creates an alias: https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. + +You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html @@ -13,21 +15,34 @@ function New-VSLambdaAlias { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description PrimitiveType: String UpdateType: Mutable .PARAMETER FunctionName + The name of the Lambda function. +**Name formats** ++ **Function name** - MyFunction. ++ **Function ARN** - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. ++ **Partial ARN** - 123456789012:function:MyFunction. +The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionVersion + The function version that the alias invokes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name PrimitiveType: String UpdateType: Immutable @@ -38,6 +53,8 @@ function New-VSLambdaAlias { UpdateType: Mutable .PARAMETER RoutingConfig + The routing configuration: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html of the alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig Type: AliasRoutingConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 index 999a24374..57c31aba8 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 @@ -1,10 +1,18 @@ function New-VSLambdaEventSourceMapping { <# .SYNOPSIS - Adds an AWS::Lambda::EventSourceMapping resource to the template. + Adds an AWS::Lambda::EventSourceMapping resource to the template. The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function. .DESCRIPTION - Adds an AWS::Lambda::EventSourceMapping resource to the template. + Adds an AWS::Lambda::EventSourceMapping resource to the template. The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function. + +For details about each event source type, see the following topics. + ++ Using AWS Lambda with Amazon Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html + ++ Using AWS Lambda with Amazon SQS: https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html + ++ Using AWS Lambda with Amazon DynamoDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html @@ -13,6 +21,11 @@ function New-VSLambdaEventSourceMapping { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BatchSize + The maximum number of items to retrieve in a single batch. ++ **Amazon Kinesis** - Default 100. Max 10,000. ++ **Amazon DynamoDB Streams** - Default 100. Max 1,000. ++ **Amazon Simple Queue Service** - Default 10. Max 10. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize PrimitiveType: Integer UpdateType: Mutable @@ -28,21 +41,38 @@ function New-VSLambdaEventSourceMapping { UpdateType: Mutable .PARAMETER Enabled + Disables the event source mapping to pause polling and invocation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EventSourceArn + The Amazon Resource Name ARN of the event source. ++ **Amazon Kinesis** - The ARN of the data stream or a stream consumer. ++ **Amazon DynamoDB Streams** - The ARN of the stream. ++ **Amazon Simple Queue Service** - The ARN of the queue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionName + The name of the Lambda function. +**Name formats** ++ **Function name** - MyFunction. ++ **Function ARN** - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. ++ **Version or Alias ARN** - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. ++ **Partial ARN** - 123456789012:function:MyFunction. +The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname PrimitiveType: String UpdateType: Mutable .PARAMETER MaximumBatchingWindowInSeconds + The maximum amount of time to gather records before invoking the function, in seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds PrimitiveType: Integer UpdateType: Mutable @@ -63,6 +93,8 @@ function New-VSLambdaEventSourceMapping { UpdateType: Mutable .PARAMETER StartingPosition + The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 index b5455f88a..b8d78f896 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 @@ -1,10 +1,10 @@ function New-VSLambdaFunction { <# .SYNOPSIS - Adds an AWS::Lambda::Function resource to the template. + Adds an AWS::Lambda::Function resource to the template. The AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a deployment package: https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html and an execution role: https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. .DESCRIPTION - Adds an AWS::Lambda::Function resource to the template. + Adds an AWS::Lambda::Function resource to the template. The AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a deployment package: https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html and an execution role: https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html @@ -13,41 +13,58 @@ function New-VSLambdaFunction { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Code + The code for the function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code Type: Code UpdateType: Mutable .PARAMETER DeadLetterConfig + A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues: https://docs.aws.amazon.com/lambda/latest/dg/dlq.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig Type: DeadLetterConfig UpdateType: Mutable .PARAMETER Description + A description of the function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description PrimitiveType: String UpdateType: Mutable .PARAMETER Environment + Environment variables that are accessible from function code during execution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment Type: Environment UpdateType: Mutable .PARAMETER FunctionName + The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname PrimitiveType: String UpdateType: Immutable .PARAMETER Handler + The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model: https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler PrimitiveType: String UpdateType: Mutable .PARAMETER KmsKeyArn + The ARN of the AWS Key Management Service AWS KMS key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn PrimitiveType: String UpdateType: Mutable .PARAMETER Layers + A list of function layers: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html to add to the function's execution environment. Specify each layer by its ARN, including the version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers DuplicatesAllowed: False PrimitiveItemType: String @@ -55,26 +72,36 @@ function New-VSLambdaFunction { UpdateType: Mutable .PARAMETER MemorySize + The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize PrimitiveType: Integer UpdateType: Mutable .PARAMETER ReservedConcurrentExecutions + The number of simultaneous executions to reserve for the function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions PrimitiveType: Integer UpdateType: Mutable .PARAMETER Role + The Amazon Resource Name ARN of the function's execution role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role PrimitiveType: String UpdateType: Mutable .PARAMETER Runtime + The identifier of the function's runtime: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A list of tags: https://docs.aws.amazon.com/lambda/latest/dg/tagging.html to apply to the function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags DuplicatesAllowed: True ItemType: Tag @@ -82,16 +109,22 @@ function New-VSLambdaFunction { UpdateType: Mutable .PARAMETER Timeout + The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout PrimitiveType: Integer UpdateType: Mutable .PARAMETER TracingConfig + Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig Type: TracingConfig UpdateType: Mutable .PARAMETER VpcConfig + For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings: https://docs.aws.amazon.com/lambda/latest/dg/vpc.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig Type: VpcConfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 index 383eb1754..b13f76c53 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 @@ -1,10 +1,10 @@ function New-VSLambdaLayerVersion { <# .SYNOPSIS - Adds an AWS::Lambda::LayerVersion resource to the template. + Adds an AWS::Lambda::LayerVersion resource to the template. The AWS::Lambda::LayerVersion resource creates an AWS Lambda layer: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html from a ZIP archive. .DESCRIPTION - Adds an AWS::Lambda::LayerVersion resource to the template. + Adds an AWS::Lambda::LayerVersion resource to the template. The AWS::Lambda::LayerVersion resource creates an AWS Lambda layer: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html from a ZIP archive. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html @@ -13,27 +13,40 @@ function New-VSLambdaLayerVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CompatibleRuntimes + A list of compatible function runtimes: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html. Used for filtering with ListLayers: https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayers.html and ListLayerVersions: https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayerVersions.html. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes UpdateType: Immutable .PARAMETER LicenseInfo + The layer's software license. It can be any of the following: ++ An SPDX license identifier: https://spdx.org/licenses/. For example, MIT. ++ The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT. ++ The full text of the license. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of the version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description PrimitiveType: String UpdateType: Immutable .PARAMETER LayerName + The name or Amazon Resource Name ARN of the layer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername PrimitiveType: String UpdateType: Immutable .PARAMETER Content + The function layer archive. + Type: Content Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 index ca2268bad..0c9769b0f 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 @@ -1,10 +1,10 @@ function New-VSLambdaLayerVersionPermission { <# .SYNOPSIS - Adds an AWS::Lambda::LayerVersionPermission resource to the template. + Adds an AWS::Lambda::LayerVersionPermission resource to the template. The AWS::Lambda::LayerVersionPermission resource adds permissions to the resource-based policy of a version of an AWS Lambda layer: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization. .DESCRIPTION - Adds an AWS::Lambda::LayerVersionPermission resource to the template. + Adds an AWS::Lambda::LayerVersionPermission resource to the template. The AWS::Lambda::LayerVersionPermission resource adds permissions to the resource-based policy of a version of an AWS Lambda layer: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html @@ -13,21 +13,29 @@ function New-VSLambdaLayerVersionPermission { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Action + The API action that grants access to the layer. For example, lambda:GetLayerVersion. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action PrimitiveType: String UpdateType: Immutable .PARAMETER LayerVersionArn + The Amazon Resource Name ARN of the layer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn PrimitiveType: String UpdateType: Immutable .PARAMETER OrganizationId + With the principal set to *, grant permission to all accounts in the specified organization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid PrimitiveType: String UpdateType: Immutable .PARAMETER Principal + An account ID, or * to grant permission to all AWS accounts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 index 5e7c73b2f..a48200c4e 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 @@ -1,10 +1,14 @@ function New-VSLambdaPermission { <# .SYNOPSIS - Adds an AWS::Lambda::Permission resource to the template. + Adds an AWS::Lambda::Permission resource to the template. The AWS::Lambda::Permission resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN of that version or alias to invoke the function. .DESCRIPTION - Adds an AWS::Lambda::Permission resource to the template. + Adds an AWS::Lambda::Permission resource to the template. The AWS::Lambda::Permission resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN of that version or alias to invoke the function. + +To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. + +This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies: https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html @@ -13,31 +17,48 @@ function New-VSLambdaPermission { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Action + The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action PrimitiveType: String UpdateType: Immutable .PARAMETER EventSourceToken + For Alexa Smart Home functions, a token that must be supplied by the invoker. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken PrimitiveType: String UpdateType: Immutable .PARAMETER FunctionName + The name of the Lambda function, version, or alias. +**Name formats** ++ **Function name** - my-function name-only, my-function:v1 with alias. ++ **Function ARN** - arn:aws:lambda:us-west-2:123456789012:function:my-function. ++ **Partial ARN** - 123456789012:function:my-function. +You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname PrimitiveType: String UpdateType: Immutable .PARAMETER Principal + The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal PrimitiveType: String UpdateType: Immutable .PARAMETER SourceAccount + For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account for example, all of an account's Amazon S3 buckets. Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount PrimitiveType: String UpdateType: Immutable .PARAMETER SourceArn + For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 index a3f6d60ce..fa14839fc 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 @@ -1,10 +1,10 @@ function New-VSLambdaVersion { <# .SYNOPSIS - Adds an AWS::Lambda::Version resource to the template. + Adds an AWS::Lambda::Version resource to the template. The AWS::Lambda::Version resource creates a version: https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. .DESCRIPTION - Adds an AWS::Lambda::Version resource to the template. + Adds an AWS::Lambda::Version resource to the template. The AWS::Lambda::Version resource creates a version: https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html @@ -13,16 +13,27 @@ function New-VSLambdaVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CodeSha256 + Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256 PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description for the version to override the description in the function configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description PrimitiveType: String UpdateType: Mutable .PARAMETER FunctionName + The name of the Lambda function. +**Name formats** ++ **Function name** - MyFunction. ++ **Function ARN** - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. ++ **Partial ARN** - 123456789012:function:MyFunction. +The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 b/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 index 2aed05c72..708e5e774 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 @@ -1,10 +1,10 @@ function New-VSLogsDestination { <# .SYNOPSIS - Adds an AWS::Logs::Destination resource to the template. + Adds an AWS::Logs::Destination resource to the template. The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream and enables you to subscribe that resource to a stream of log events. .DESCRIPTION - Adds an AWS::Logs::Destination resource to the template. + Adds an AWS::Logs::Destination resource to the template. The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream and enables you to subscribe that resource to a stream of log events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html @@ -13,21 +13,29 @@ function New-VSLogsDestination { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DestinationName + The name of the destination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationPolicy + An IAM policy document that governs which AWS accounts can create subscription filters against this destination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER TargetArn + The Amazon Resource Name ARN of the physical target to where the log events are delivered for example, a Kinesis stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 b/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 index 48f4489f4..a3da26ad2 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 @@ -1,10 +1,22 @@ function New-VSLogsLogGroup { <# .SYNOPSIS - Adds an AWS::Logs::LogGroup resource to the template. + Adds an AWS::Logs::LogGroup resource to the template. The AWS::Logs::LogGroup resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group. .DESCRIPTION - Adds an AWS::Logs::LogGroup resource to the template. + Adds an AWS::Logs::LogGroup resource to the template. The AWS::Logs::LogGroup resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group. + +You can create up to 5000 log groups per account. You must use the following guidelines when naming a log group: + ++ Log group names must be unique within a Region for an AWS account. + ++ Log group names can be between 1 and 512 characters long. + ++ Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore, '-' (hyphen, '/' (forward slash, and '.' (period. + +If you associate a AWS Key Management Service (AWS KMS customer master key (CMK with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. + +If you attempt to associate a CMK with the log group but the CMK doesn't exist or the CMK is disabled, you will receive an InvalidParameterException error. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html @@ -13,11 +25,15 @@ function New-VSLogsLogGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LogGroupName + The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-loggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER RetentionInDays + The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-retentionindays PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 b/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 index e691501b4..d6cca1138 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 @@ -1,10 +1,20 @@ function New-VSLogsLogStream { <# .SYNOPSIS - Adds an AWS::Logs::LogStream resource to the template. + Adds an AWS::Logs::LogStream resource to the template. The AWS::Logs::LogStream resource specifies an Amazon CloudWatch Logs log stream in a specific log group. A log stream represents the sequence of events coming from an application instance or resource that you are monitoring. .DESCRIPTION - Adds an AWS::Logs::LogStream resource to the template. + Adds an AWS::Logs::LogStream resource to the template. The AWS::Logs::LogStream resource specifies an Amazon CloudWatch Logs log stream in a specific log group. A log stream represents the sequence of events coming from an application instance or resource that you are monitoring. + +There is no limit on the number of log streams that you can create for a log group. + +You must use the following guidelines when naming a log stream: + ++ Log stream names must be unique within the log group. + ++ Log stream names can be between 1 and 512 characters long. + ++ The ':' (colon and '*' (asterisk characters are not allowed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html @@ -13,11 +23,15 @@ function New-VSLogsLogStream { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LogGroupName + The name of the log group where the log stream is created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER LogStreamName + The name of the log stream. The name must be unique within the log group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 b/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 index 4649b57b5..61255819d 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 @@ -1,10 +1,12 @@ function New-VSLogsMetricFilter { <# .SYNOPSIS - Adds an AWS::Logs::MetricFilter resource to the template. + Adds an AWS::Logs::MetricFilter resource to the template. The AWS::Logs::MetricFilter resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group. .DESCRIPTION - Adds an AWS::Logs::MetricFilter resource to the template. + Adds an AWS::Logs::MetricFilter resource to the template. The AWS::Logs::MetricFilter resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group. + +The maximum number of metric filters that can be associated with a log group is 100. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html @@ -13,16 +15,22 @@ function New-VSLogsMetricFilter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FilterPattern + A filter pattern for extracting metric data out of ingested log events. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-filterpattern PrimitiveType: String UpdateType: Mutable .PARAMETER LogGroupName + The name of an existing log group that you want to associate with this metric filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-loggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER MetricTransformations + The metric transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-metrictransformations DuplicatesAllowed: False ItemType: MetricTransformation diff --git a/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 b/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 index fedc028c1..03b791550 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 @@ -1,10 +1,20 @@ function New-VSLogsSubscriptionFilter { <# .SYNOPSIS - Adds an AWS::Logs::SubscriptionFilter resource to the template. + Adds an AWS::Logs::SubscriptionFilter resource to the template. The AWS::Logs::SubscriptionFilter resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are: .DESCRIPTION - Adds an AWS::Logs::SubscriptionFilter resource to the template. + Adds an AWS::Logs::SubscriptionFilter resource to the template. The AWS::Logs::SubscriptionFilter resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are: + ++ An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery. + ++ A logical destination that belongs to a different account, for cross-account delivery. + ++ An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. + ++ An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery. + +There can only be one subscription filter associated with a log group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html @@ -13,21 +23,29 @@ function New-VSLogsSubscriptionFilter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DestinationArn + The Amazon Resource Name ARN of the destination. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-destinationarn PrimitiveType: String UpdateType: Immutable .PARAMETER FilterPattern + The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern PrimitiveType: String UpdateType: Immutable .PARAMETER LogGroupName + The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn + The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-rolearn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 b/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 index 51446a34a..a2d1bfee3 100644 --- a/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 @@ -1,10 +1,10 @@ function New-VSMSKCluster { <# .SYNOPSIS - Adds an AWS::MSK::Cluster resource to the template. + Adds an AWS::MSK::Cluster resource to the template. The AWS::MSK::Cluster resource creates an Amazon MSK cluster. For more information, see What Is Amazon MSK?: https://docs.aws.amazon.com/msk/latest/developerguide/what-is-msk.html in the *Amazon MSK Developer Guide*. .DESCRIPTION - Adds an AWS::MSK::Cluster resource to the template. + Adds an AWS::MSK::Cluster resource to the template. The AWS::MSK::Cluster resource creates an Amazon MSK cluster. For more information, see What Is Amazon MSK?: https://docs.aws.amazon.com/msk/latest/developerguide/what-is-msk.html in the *Amazon MSK Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html @@ -13,26 +13,36 @@ function New-VSMSKCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BrokerNodeGroupInfo + The setup to be used for brokers in the cluster. + Type: BrokerNodeGroupInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-brokernodegroupinfo UpdateType: Immutable .PARAMETER EnhancedMonitoring + Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-enhancedmonitoring PrimitiveType: String UpdateType: Mutable .PARAMETER KafkaVersion + The version of Apache Kafka. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-kafkaversion PrimitiveType: String UpdateType: Immutable .PARAMETER NumberOfBrokerNodes + The number of broker nodes you want in the Amazon MSK cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-numberofbrokernodes PrimitiveType: Integer UpdateType: Mutable .PARAMETER EncryptionInfo + Includes all encryption-related information. + Type: EncryptionInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-encryptioninfo UpdateType: Immutable @@ -43,21 +53,30 @@ function New-VSMSKCluster { UpdateType: Mutable .PARAMETER ClusterName + The name of the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clustername PrimitiveType: String UpdateType: Immutable .PARAMETER ClientAuthentication + Includes information related to client authentication. + Type: ClientAuthentication Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clientauthentication UpdateType: Immutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. You can specify tags in JSON or in YAML, depending on which format you use for your template. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-tags PrimitiveType: Json UpdateType: Immutable .PARAMETER ConfigurationInfo + The Amazon MSK configuration to use for the cluster. + Type: ConfigurationInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-configurationinfo UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 b/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 index 81520c32e..7756fb9b9 100644 --- a/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 +++ b/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 @@ -1,10 +1,10 @@ function New-VSManagedBlockchainMember { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Member resource to the template. + Adds an AWS::ManagedBlockchain::Member resource to the template. Creates a member within a Managed Blockchain network. .DESCRIPTION - Adds an AWS::ManagedBlockchain::Member resource to the template. + Adds an AWS::ManagedBlockchain::Member resource to the template. Creates a member within a Managed Blockchain network. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html @@ -13,21 +13,29 @@ function New-VSManagedBlockchainMember { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MemberConfiguration + Configuration properties of the member. + Type: MemberConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-memberconfiguration UpdateType: Mutable .PARAMETER NetworkConfiguration + Configuration properties of the network to which the member belongs. + Type: NetworkConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-networkconfiguration UpdateType: Mutable .PARAMETER NetworkId + The unique identifier of the network to which the member belongs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-networkid PrimitiveType: String UpdateType: Mutable .PARAMETER InvitationId + The unique identifier of the invitation to join the network sent to the account that creates the member. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-invitationid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 b/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 index bf4f89210..ff5381195 100644 --- a/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 +++ b/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 @@ -1,10 +1,10 @@ function New-VSManagedBlockchainNode { <# .SYNOPSIS - Adds an AWS::ManagedBlockchain::Node resource to the template. + Adds an AWS::ManagedBlockchain::Node resource to the template. Creates a peer node in a member. .DESCRIPTION - Adds an AWS::ManagedBlockchain::Node resource to the template. + Adds an AWS::ManagedBlockchain::Node resource to the template. Creates a peer node in a member. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-node.html @@ -13,16 +13,22 @@ function New-VSManagedBlockchainNode { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MemberId + The unique identifier of the member to which the node belongs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-node.html#cfn-managedblockchain-node-memberid PrimitiveType: String UpdateType: Mutable .PARAMETER NetworkId + The unique identifier of the network that the node is in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-node.html#cfn-managedblockchain-node-networkid PrimitiveType: String UpdateType: Mutable .PARAMETER NodeConfiguration + Configuration properties of a peer node. + Type: NodeConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-node.html#cfn-managedblockchain-node-nodeconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 b/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 index 70875de8e..761ccc6ea 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 @@ -1,10 +1,12 @@ function New-VSMediaLiveChannel { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel resource to the template. + Adds an AWS::MediaLive::Channel resource to the template. The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel. .DESCRIPTION - Adds an AWS::MediaLive::Channel resource to the template. + Adds an AWS::MediaLive::Channel resource to the template. The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel. + +A MediaLive channel ingests and transcodes (decodes and encodes source content from the inputs that are attached to that channel, and packages the new content into outputs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html @@ -13,48 +15,66 @@ function New-VSMediaLiveChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InputAttachments + The list of input attachments for the channel. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputattachments ItemType: InputAttachment UpdateType: Mutable .PARAMETER InputSpecification + The input specification for this channel. It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec. + Type: InputSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputspecification UpdateType: Mutable .PARAMETER ChannelClass + The class for this channel. For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelclass PrimitiveType: String UpdateType: Mutable .PARAMETER EncoderSettings + The encoding configuration for the output content. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-encodersettings PrimitiveType: Json UpdateType: Mutable .PARAMETER Destinations + The settings that identify the destination for the outputs in this MediaLive output package. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-destinations ItemType: OutputDestination UpdateType: Mutable .PARAMETER LogLevel + The verbosity for logging activity for this channel. Charges for logging which are generated through Amazon CloudWatch Logging are higher for higher verbosities. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-loglevel PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The IAM role for MediaLive to assume when running this channel. The role is identified by its ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A collection of tags for this channel. Each tag is a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + A name for this audio selector. The AudioDescription in an output references this name in order to identify a specific input audio to include in that output. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 b/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 index 673a754e8..7257a3bf5 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 @@ -1,10 +1,12 @@ function New-VSMediaLiveInput { <# .SYNOPSIS - Adds an AWS::MediaLive::Input resource to the template. + Adds an AWS::MediaLive::Input resource to the template. The AWS::MediaLive::Input resource is a MediaLive resource type that creates an input. .DESCRIPTION - Adds an AWS::MediaLive::Input resource to the template. + Adds an AWS::MediaLive::Input resource to the template. The AWS::MediaLive::Input resource is a MediaLive resource type that creates an input. + +A MediaLive input holds information that describes how the MediaLive channel is connected to the upstream system that is providing the source content that is to be transcoded. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html @@ -13,50 +15,68 @@ function New-VSMediaLiveInput { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type for this input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-type PrimitiveType: String UpdateType: Immutable .PARAMETER Destinations + The destination settings for push types of inputs. If the input is a pull type, these settings don't apply. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-destinations ItemType: InputDestinationRequest UpdateType: Mutable .PARAMETER Vpc + Settings that apply only if the input is an Amazon VPC input. + Type: InputVpcRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-vpc UpdateType: Immutable .PARAMETER MediaConnectFlows + Settings that apply only if the input is a MediaConnect input. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-mediaconnectflows ItemType: MediaConnectFlowRequest UpdateType: Mutable .PARAMETER InputSecurityGroups + The list of input security groups referenced by IDs to attach to the input if the input is a push type. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-inputsecuritygroups UpdateType: Mutable .PARAMETER Sources + The source settings for a pull type of input. These settings don't apply if the input is a push type. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-sources ItemType: InputSourceRequest UpdateType: Mutable .PARAMETER RoleArn + The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input. This doesn't apply to other types of inputs. The role is identified by its ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A collection of tags for this input. Each tag is a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + A name for the input. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html#cfn-medialive-input-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 index b59bbce23..4756c6abf 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 @@ -1,10 +1,12 @@ function New-VSMediaLiveInputSecurityGroup { <# .SYNOPSIS - Adds an AWS::MediaLive::InputSecurityGroup resource to the template. + Adds an AWS::MediaLive::InputSecurityGroup resource to the template. The AWS::MediaLive::InputSecurityGroup is a MediaLive resource type that creates an input security group. .DESCRIPTION - Adds an AWS::MediaLive::InputSecurityGroup resource to the template. + Adds an AWS::MediaLive::InputSecurityGroup resource to the template. The AWS::MediaLive::InputSecurityGroup is a MediaLive resource type that creates an input security group. + +A MediaLive input security group is associated with a MediaLive input. The input security group is an "allow list" of IP addresses that controls whether an external IP address can push content to the associated MediaLive input. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html @@ -13,12 +15,16 @@ function New-VSMediaLiveInputSecurityGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER WhitelistRules + The list of IPv4 CIDR addresses to include in the input security group as "allowed" addresses. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html#cfn-medialive-inputsecuritygroup-whitelistrules ItemType: InputWhitelistRuleCidr UpdateType: Mutable .PARAMETER Tags + A collection of tags for this input security group. Each tag is a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html#cfn-medialive-inputsecuritygroup-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 b/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 index 744e02b5b..cafbbe6dc 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 @@ -1,10 +1,12 @@ function New-VSMediaStoreContainer { <# .SYNOPSIS - Adds an AWS::MediaStore::Container resource to the template. + Adds an AWS::MediaStore::Container resource to the template. The AWS::MediaStore::Container resource specifies a storage container to hold objects. A container is similar to a bucket in Amazon S3. .DESCRIPTION - Adds an AWS::MediaStore::Container resource to the template. + Adds an AWS::MediaStore::Container resource to the template. The AWS::MediaStore::Container resource specifies a storage container to hold objects. A container is similar to a bucket in Amazon S3. + +When you create a container using AWS CloudFormation, the template manages data for five API actions: creating a container, setting access logging, updating the default container policy, adding a cross-origin resource sharing (CORS policy, and adding an object lifecycle policy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html @@ -13,27 +15,41 @@ function New-VSMediaStoreContainer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Policy + Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide: https://aws.amazon.com/documentation/iam/. +For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-policy PrimitiveType: String UpdateType: Mutable .PARAMETER ContainerName + The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-containername PrimitiveType: String UpdateType: Immutable .PARAMETER CorsPolicy + Sets the cross-origin resource sharing CORS configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability. +To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. +To learn more about CORS, see Cross-Origin Resource Sharing CORS in AWS Elemental MediaStore: https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-corspolicy ItemType: CorsRule UpdateType: Mutable .PARAMETER LifecyclePolicy + Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. +For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy: https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-lifecyclepolicy PrimitiveType: String UpdateType: Mutable .PARAMETER AccessLoggingEnabled + The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true, indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediastore-container.html#cfn-mediastore-container-accessloggingenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 index bebc22096..d7d8bd949 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 @@ -1,10 +1,16 @@ function New-VSNeptuneDBCluster { <# .SYNOPSIS - Adds an AWS::Neptune::DBCluster resource to the template. + Adds an AWS::Neptune::DBCluster resource to the template. The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database. .DESCRIPTION - Adds an AWS::Neptune::DBCluster resource to the template. + Adds an AWS::Neptune::DBCluster resource to the template. The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database. + +**Note** + +Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported. + +If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html @@ -13,89 +19,128 @@ function New-VSNeptuneDBCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER StorageEncrypted + Indicates whether the DB cluster is encrypted. +If you specify the DBClusterIdentifier, DBSnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption. +If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-storageencrypted PrimitiveType: Boolean UpdateType: Immutable .PARAMETER EngineVersion + The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-engineversion PrimitiveType: String UpdateType: Immutable .PARAMETER KmsKeyId + If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZones + Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-availabilityzones UpdateType: Immutable .PARAMETER SnapshotIdentifier + Not supported by Neptune. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER Port + Specifies the port that the database engine is listening on. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER DBClusterIdentifier + Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER IamAuthEnabled + True if mapping of AWS Identity and Access Management IAM accounts to database accounts is enabled, and otherwise false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-iamauthenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DBSubnetGroupName + Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DeletionProtection + The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-deletionprotection PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PreferredBackupWindow + Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. +An update may require some interruption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredbackupwindow PrimitiveType: String UpdateType: Mutable .PARAMETER VpcSecurityGroupIds + Provides a list of VPC security groups that the DB cluster belongs to. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-vpcsecuritygroupids UpdateType: Mutable .PARAMETER DBClusterParameterGroupName + Provides the name of the DB cluster parameter group. +An update may require some interruption. See ModifyDBInstance: https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance in the Amazon Neptune User Guide for more information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusterparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER BackupRetentionPeriod + Specifies the number of days for which automatic DB snapshots are retained. +An update may require some interruption. See ModifyDBInstance: https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance in the Amazon Neptune User Guide for more information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-backupretentionperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tags + The tags assigned to this cluster. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-tags ItemType: Tag UpdateType: Mutable .PARAMETER EnableCloudwatchLogsExports + Specifies a list of log types that are enabled for export to CloudWatch Logs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-enablecloudwatchlogsexports diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 index f0e7e8c8c..1f338c4f3 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 @@ -1,10 +1,14 @@ function New-VSNeptuneDBClusterParameterGroup { <# .SYNOPSIS - Adds an AWS::Neptune::DBClusterParameterGroup resource to the template. + Adds an AWS::Neptune::DBClusterParameterGroup resource to the template. The AWS::Neptune::DBClusterParameterGroup resource creates a new Amazon Neptune DB cluster parameter group. .DESCRIPTION - Adds an AWS::Neptune::DBClusterParameterGroup resource to the template. + Adds an AWS::Neptune::DBClusterParameterGroup resource to the template. The AWS::Neptune::DBClusterParameterGroup resource creates a new Amazon Neptune DB cluster parameter group. + +**Note** + +Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html @@ -13,27 +17,39 @@ function New-VSNeptuneDBClusterParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Provides the customer-specified description for this DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + The parameters to set for this DB cluster parameter group. +The parameters are expressed as a JSON object consisting of key-value pairs. +If you update the parameters, some interruption may occur depending on which parameters you update. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER Family + Must be neptune1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-family PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags that you want to attach to this parameter group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + Provides the name of the DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 index 2d3c1fb81..b31c8ea41 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 @@ -1,10 +1,38 @@ function New-VSNeptuneDBInstance { <# .SYNOPSIS - Adds an AWS::Neptune::DBInstance resource to the template. + Adds an AWS::Neptune::DBInstance resource to the template. The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance. .DESCRIPTION - Adds an AWS::Neptune::DBInstance resource to the template. + Adds an AWS::Neptune::DBInstance resource to the template. The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance. + +**Updating DB Instances** + +You can set a deletion policy for your DB instance to control how AWS CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to *retain* the instance, to *delete* the instance, or to *create a snapshot* of the instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property: + ++ For AWS::Neptune::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance. + ++ For AWS::Neptune::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance. + +**Deleting DB Instances** + +**Important** + +If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. + +When properties labeled *Update requires: Replacement* are updated, AWS CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance. + +**Important** + +We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure: + +Deactivate any applications that are using the DB instance so that there's no activity on the DB instance. + +Create a snapshot of the DB instance. + +If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use. + +Update the stack. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html @@ -13,56 +41,82 @@ function New-VSNeptuneDBInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBParameterGroupName + The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER DBInstanceClass + Contains the name of the compute and memory capacity class of the DB instance. +If you update this property, some interruptions may occur. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceclass PrimitiveType: String UpdateType: Mutable .PARAMETER AllowMajorVersionUpgrade + Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-allowmajorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DBClusterIdentifier + If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZone + Specifies the name of the Availability Zone the DB instance is located in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade + Indicates that minor version patches are applied automatically. +When updating this property, some interruptions may occur. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-autominorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DBSubnetGroupName + A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DBInstanceIdentifier + Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER DBSnapshotIdentifier + This parameter is not supported. +AWS::Neptune::DBInstance does not support restoring from snapshots. +AWS::Neptune::DBCluster does support restoring from snapshots. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsnapshotidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + An arbitrary set of tags key-value pairs for this DB instance. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 index dccd17c99..119995adf 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 @@ -1,10 +1,20 @@ function New-VSNeptuneDBParameterGroup { <# .SYNOPSIS - Adds an AWS::Neptune::DBParameterGroup resource to the template. + Adds an AWS::Neptune::DBParameterGroup resource to the template. AWS::Neptune::DBParameterGroup creates a new DB parameter group. This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance. .DESCRIPTION - Adds an AWS::Neptune::DBParameterGroup resource to the template. + Adds an AWS::Neptune::DBParameterGroup resource to the template. AWS::Neptune::DBParameterGroup creates a new DB parameter group. This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance. + +**Note** + +Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot. + +A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using *ModifyDBParameterGroup*. Once you've created a DB parameter group, you need to associate it with your DB instance using *ModifyDBInstance*. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. + +**Important** + +After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the *Parameter Groups* option of the Amazon Neptune console or the *DescribeDBParameters* command to verify that your DB parameter group has been created or modified. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html @@ -13,27 +23,39 @@ function New-VSNeptuneDBParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Provides the customer-specified description for this DB parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + The parameters to set for this DB parameter group. +The parameters are expressed as a JSON object consisting of key-value pairs. +Changes to dynamic parameters are applied immediately. During an update, if you have static parameters whether they were changed or not, it triggers AWS CloudFormation to reboot the associated DB instance without failover. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER Family + Must be neptune1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-family PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags that you want to attach to this parameter group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + Provides the name of the DB parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 index f646bd4b0..bc27e753e 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSNeptuneDBSubnetGroup { <# .SYNOPSIS - Adds an AWS::Neptune::DBSubnetGroup resource to the template. + Adds an AWS::Neptune::DBSubnetGroup resource to the template. The AWS::Neptune::DBSubnetGroup type creates an Amazon Neptune DB subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS Region. .DESCRIPTION - Adds an AWS::Neptune::DBSubnetGroup resource to the template. + Adds an AWS::Neptune::DBSubnetGroup resource to the template. The AWS::Neptune::DBSubnetGroup type creates an Amazon Neptune DB subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS Region. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html @@ -13,22 +13,30 @@ function New-VSNeptuneDBSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBSubnetGroupName + The name of the DB subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DBSubnetGroupDescription + Provides the description of the DB subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-dbsubnetgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds + The Amazon EC2 subnet IDs for the DB subnet group. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-subnetids UpdateType: Mutable .PARAMETER Tags + The tags that you want to attach to the DB subnet group. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 index 497c07e75..9b69673aa 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 @@ -1,10 +1,12 @@ function New-VSOpsWorksApp { <# .SYNOPSIS - Adds an AWS::OpsWorks::App resource to the template. + Adds an AWS::OpsWorks::App resource to the template. Creates an app for a specified stack. For more information, see Creating Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html. .DESCRIPTION - Adds an AWS::OpsWorks::App resource to the template. + Adds an AWS::OpsWorks::App resource to the template. Creates an app for a specified stack. For more information, see Creating Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html. + +**Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html @@ -13,11 +15,15 @@ function New-VSOpsWorksApp { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AppSource + A Source object that specifies the app repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource Type: Source UpdateType: Mutable .PARAMETER Attributes + One or more user-defined key/value pairs to be added to the stack attributes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes DuplicatesAllowed: False PrimitiveItemType: String @@ -25,6 +31,8 @@ function New-VSOpsWorksApp { UpdateType: Mutable .PARAMETER DataSources + The app's data source. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources DuplicatesAllowed: False ItemType: DataSource @@ -32,11 +40,15 @@ function New-VSOpsWorksApp { UpdateType: Mutable .PARAMETER Description + A description of the app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description PrimitiveType: String UpdateType: Mutable .PARAMETER Domains + The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com' + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains DuplicatesAllowed: True PrimitiveItemType: String @@ -44,11 +56,17 @@ function New-VSOpsWorksApp { UpdateType: Mutable .PARAMETER EnableSsl + Whether to enable SSL for the app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Environment + An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment. +There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large maximum is 20KB." +If you have specified one or more environment variables, you cannot modify the stack's Chef version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment DuplicatesAllowed: True ItemType: EnvironmentVariable @@ -56,26 +74,36 @@ function New-VSOpsWorksApp { UpdateType: Mutable .PARAMETER Name + The app name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name PrimitiveType: String UpdateType: Mutable .PARAMETER Shortname + The app's short name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname PrimitiveType: String UpdateType: Immutable .PARAMETER SslConfiguration + An SslConfiguration object with the SSL configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration Type: SslConfiguration UpdateType: Mutable .PARAMETER StackId + The stack ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid PrimitiveType: String UpdateType: Immutable .PARAMETER Type + The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 index fdedf819d..163bb6f31 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 @@ -1,10 +1,10 @@ function New-VSOpsWorksCMServer { <# .SYNOPSIS - Adds an AWS::OpsWorksCM::Server resource to the template. + Adds an AWS::OpsWorksCM::Server resource to the template. The AWS::OpsWorksCM::Server resource creates an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise configuration management server. For more information, see Create a Chef Automate Server in AWS CloudFormation: https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-create-server-cfn.html or Create a Puppet Enterprise Master in AWS CloudFormation: https://docs.aws.amazon.com/opsworks/latest/userguide/opspup-create-server-cfn.html in the *AWS OpsWorks User Guide*, and CreateServer: https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference*. .DESCRIPTION - Adds an AWS::OpsWorksCM::Server resource to the template. + Adds an AWS::OpsWorksCM::Server resource to the template. The AWS::OpsWorksCM::Server resource creates an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise configuration management server. For more information, see Create a Chef Automate Server in AWS CloudFormation: https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-create-server-cfn.html or Create a Puppet Enterprise Master in AWS CloudFormation: https://docs.aws.amazon.com/opsworks/latest/userguide/opspup-create-server-cfn.html in the *AWS OpsWorks User Guide*, and CreateServer: https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html @@ -13,110 +13,169 @@ function New-VSOpsWorksCMServer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KeyPair + The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-keypair PrimitiveType: String UpdateType: Immutable .PARAMETER EngineVersion + The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineversion PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceRoleArn + The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-servicerolearn PrimitiveType: String UpdateType: Immutable .PARAMETER DisableAutomatedBackup + Enable or disable scheduled backups. Valid values are true or false. The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-disableautomatedbackup PrimitiveType: Boolean UpdateType: Mutable .PARAMETER BackupId + If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupid PrimitiveType: String UpdateType: Immutable .PARAMETER EngineModel + The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-enginemodel PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time UTC. The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information. +**Example:** Mon:08:00, which represents a start time of every Monday at 08:00 UTC. 8:00 a.m. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER AssociatePublicIpAddress + Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-associatepublicipaddress PrimitiveType: Boolean UpdateType: Immutable .PARAMETER InstanceProfileArn + The ARN of the instance profile that your Amazon EC2 instances use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instanceprofilearn PrimitiveType: String UpdateType: Immutable .PARAMETER CustomCertificate + + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customcertificate PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredBackupWindow + The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats: ++ HH:MM for daily backups ++ DDD:HH:MM for weekly backups +The specified time is in coordinated universal time UTC. The default value is a random, daily start time. +**Example:** 08:00, which represents a daily start time of 08:00 UTC. +**Example:** Mon:08:00, which represents a start time of every Monday at 08:00 UTC. 8:00 a.m. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredbackupwindow PrimitiveType: String UpdateType: Mutable .PARAMETER SecurityGroupIds + A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds. +If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 everyone. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-securitygroupids UpdateType: Immutable .PARAMETER SubnetIds + The IDs of subnets in which to launch the server EC2 instance. +Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. +EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled. +For more information about supported Amazon EC2 platforms, see Supported Platforms: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-subnetids UpdateType: Immutable .PARAMETER CustomDomain + + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customdomain PrimitiveType: String UpdateType: Immutable .PARAMETER CustomPrivateKey + + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customprivatekey PrimitiveType: String UpdateType: Immutable .PARAMETER ServerName + The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens - are allowed, up to a maximum of 40 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-servername PrimitiveType: String UpdateType: Immutable .PARAMETER EngineAttributes + Optional engine attributes on a specified server. +**Attributes accepted in a Chef createServer request:** ++ CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. ++ CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters !/@#$%^&+=_. The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response. +**Attributes accepted in a Puppet createServer request:** ++ PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters. ++ PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository for example, ssh://git@your.git-repo.com:user/control-repo.git. Specifying an r10k remote opens TCP port 8170. ++ PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineattributes ItemType: EngineAttribute UpdateType: Mutable .PARAMETER BackupRetentionCount + The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupretentioncount PrimitiveType: Integer UpdateType: Mutable .PARAMETER InstanceType + The Amazon EC2 instance type to use. For example, m5.large. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-tags ItemType: Tag UpdateType: Mutable .PARAMETER Engine + The configuration management engine to use. Valid values include ChefAutomate and Puppet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engine PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 index 403ad6b95..5349068aa 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 @@ -1,10 +1,10 @@ function New-VSOpsWorksElasticLoadBalancerAttachment { <# .SYNOPSIS - Adds an AWS::OpsWorks::ElasticLoadBalancerAttachment resource to the template. + Adds an AWS::OpsWorks::ElasticLoadBalancerAttachment resource to the template. Attaches an Elastic Load Balancing load balancer to an AWS OpsWorks layer that you specify. .DESCRIPTION - Adds an AWS::OpsWorks::ElasticLoadBalancerAttachment resource to the template. + Adds an AWS::OpsWorks::ElasticLoadBalancerAttachment resource to the template. Attaches an Elastic Load Balancing load balancer to an AWS OpsWorks layer that you specify. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html @@ -13,11 +13,15 @@ function New-VSOpsWorksElasticLoadBalancerAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ElasticLoadBalancerName + The Elastic Load Balancing instance's name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-elbname PrimitiveType: String UpdateType: Mutable .PARAMETER LayerId + The AWS OpsWorks layer ID that the Elastic Load Balancing load balancer will be attached to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-layerid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 index 4743283f2..75bcc1a67 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 @@ -1,10 +1,12 @@ function New-VSOpsWorksInstance { <# .SYNOPSIS - Adds an AWS::OpsWorks::Instance resource to the template. + Adds an AWS::OpsWorks::Instance resource to the template. Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html. .DESCRIPTION - Adds an AWS::OpsWorks::Instance resource to the template. + Adds an AWS::OpsWorks::Instance resource to the template. Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html. + +**Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html @@ -13,31 +15,47 @@ function New-VSOpsWorksInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AgentVersion + The default AWS OpsWorks Stacks agent version. You have the following options: ++ INHERIT - Use the stack's default agent version setting. ++ *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. +The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions: https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion PrimitiveType: String UpdateType: Mutable .PARAMETER AmiId + A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html. +If you specify a custom AMI, you must set Os to Custom. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid PrimitiveType: String UpdateType: Mutable .PARAMETER Architecture + The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture PrimitiveType: String UpdateType: Mutable .PARAMETER AutoScalingType + For load-based or time-based instances, the type. Windows stacks can use only time-based instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZone + The Availability Zone of the AWS OpsWorks instance, such as us-east-2a. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER BlockDeviceMappings + An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html. Note that block device mappings are not supported for custom AMIs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings DuplicatesAllowed: False ItemType: BlockDeviceMapping @@ -45,11 +63,15 @@ function New-VSOpsWorksInstance { UpdateType: Immutable .PARAMETER EbsOptimized + Whether to create an Amazon EBS-optimized instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ElasticIps + A list of Elastic IP addresses to associate with the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips DuplicatesAllowed: False PrimitiveItemType: String @@ -57,21 +79,30 @@ function New-VSOpsWorksInstance { UpdateType: Mutable .PARAMETER Hostname + The instance host name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname PrimitiveType: String UpdateType: Mutable .PARAMETER InstallUpdatesOnBoot + Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment: https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/CreateDeployment to run the update_dependencies stack command or by manually running yum Amazon Linux or apt-get Ubuntu on the instances. +We strongly recommend using the default value of true to ensure that your instances have the latest security updates. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot PrimitiveType: Boolean UpdateType: Mutable .PARAMETER InstanceType + The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose **Instances**, and choose **+ Instance**. The **Size** list contains the currently supported types. For more information, see Instance Families and Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. The parameter values that you use to specify the various types are in the **API Name** column of the **Available Instance Types** table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER LayerIds + An array that contains the instance's layer IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids DuplicatesAllowed: True PrimitiveItemType: String @@ -79,46 +110,72 @@ function New-VSOpsWorksInstance { UpdateType: Mutable .PARAMETER Os + The instance's operating system, which must be set to one of the following. ++ A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. ++ A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. ++ CentOS Linux 7 ++ Red Hat Enterprise Linux 7 ++ A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. ++ A custom AMI: Custom. +For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html. +The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance: https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating Systems: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.htmlFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os PrimitiveType: String UpdateType: Mutable .PARAMETER RootDeviceType + The instance root device type. For more information, see Storage for the Root Device: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype PrimitiveType: String UpdateType: Immutable .PARAMETER SshKeyName + The instance's Amazon EC2 key-pair name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname PrimitiveType: String UpdateType: Mutable .PARAMETER StackId + The stack ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetId + The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER Tenancy + The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview: http://aws.amazon.com/ec2/dedicated-hosts/ and Amazon EC2 Dedicated Hosts: http://aws.amazon.com/ec2/dedicated-hosts/. For more information about dedicated instances, see Dedicated Instances: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html and Amazon EC2 Dedicated Instances: http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy PrimitiveType: String UpdateType: Immutable .PARAMETER TimeBasedAutoScaling + The time-based scaling configuration for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling Type: TimeBasedAutoScaling UpdateType: Immutable .PARAMETER VirtualizationType + The instance's virtualization type, paravirtual or hvm. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype PrimitiveType: String UpdateType: Immutable .PARAMETER Volumes + A list of AWS OpsWorks volume IDs to associate with the instance. For more information, see AWS::OpsWorks::Volume: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 index 56c89a3f7..3a575de99 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 @@ -1,10 +1,16 @@ function New-VSOpsWorksLayer { <# .SYNOPSIS - Adds an AWS::OpsWorks::Layer resource to the template. + Adds an AWS::OpsWorks::Layer resource to the template. Creates a layer. For more information, see How to Create a Layer: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html. .DESCRIPTION - Adds an AWS::OpsWorks::Layer resource to the template. + Adds an AWS::OpsWorks::Layer resource to the template. Creates a layer. For more information, see How to Create a Layer: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html. + +**Note** + +You should use **CreateLayer** for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, **CreateLayer** fails. A stack can have an arbitrary number of custom layers, so you can call **CreateLayer** as many times as you like for that layer type. + +**Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html @@ -13,6 +19,9 @@ function New-VSOpsWorksLayer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Attributes + One or more user-defined key-value pairs to be added to the stack attributes. +To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-attributes DuplicatesAllowed: False PrimitiveItemType: String @@ -20,31 +29,43 @@ function New-VSOpsWorksLayer { UpdateType: Mutable .PARAMETER AutoAssignElasticIps + Whether to automatically assign an Elastic IP address: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html to the layer's instances. For more information, see How to Edit a Layer: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignelasticips PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AutoAssignPublicIps + For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignpublicips PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CustomInstanceProfileArn + The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-custominstanceprofilearn PrimitiveType: String UpdateType: Mutable .PARAMETER CustomJson + A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html. This feature is supported as of version 1.7.42 of the AWS CLI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customjson PrimitiveType: Json UpdateType: Mutable .PARAMETER CustomRecipes + A LayerCustomRecipes object that specifies the layer custom recipes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customrecipes Type: Recipes UpdateType: Mutable .PARAMETER CustomSecurityGroupIds + An array containing the layer custom security group IDs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customsecuritygroupids DuplicatesAllowed: True PrimitiveItemType: String @@ -52,31 +73,44 @@ function New-VSOpsWorksLayer { UpdateType: Mutable .PARAMETER EnableAutoHealing + Whether to disable auto healing for the layer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-enableautohealing PrimitiveType: Boolean UpdateType: Mutable .PARAMETER InstallUpdatesOnBoot + Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment: https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/CreateDeployment to run the update_dependencies stack command or by manually running yum Amazon Linux or apt-get Ubuntu on the instances. +To ensure that your instances have the latest security updates, we strongly recommend using the default value of true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-installupdatesonboot PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LifecycleEventConfiguration + A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-lifecycleeventconfiguration Type: LifecycleEventConfiguration UpdateType: Mutable .PARAMETER LoadBasedAutoScaling + The load-based scaling configuration for the AWS OpsWorks layer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-loadbasedautoscaling Type: LoadBasedAutoScaling UpdateType: Mutable .PARAMETER Name + The layer name, which is used by the console. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-name PrimitiveType: String UpdateType: Mutable .PARAMETER Packages + An array of Package objects that describes the layer packages. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-packages DuplicatesAllowed: True PrimitiveItemType: String @@ -84,16 +118,23 @@ function New-VSOpsWorksLayer { UpdateType: Mutable .PARAMETER Shortname + For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. +The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference: https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-shortname PrimitiveType: String UpdateType: Mutable .PARAMETER StackId + The layer stack ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-stackid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Specifies one or more sets of tags key–value pairs to associate with this AWS OpsWorks layer. Use tags to manage your resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-tags DuplicatesAllowed: True ItemType: Tag @@ -101,16 +142,22 @@ function New-VSOpsWorksLayer { UpdateType: Mutable .PARAMETER Type + The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-type PrimitiveType: String UpdateType: Immutable .PARAMETER UseEbsOptimizedInstances + Whether to use Amazon EBS-optimized instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-useebsoptimizedinstances PrimitiveType: Boolean UpdateType: Mutable .PARAMETER VolumeConfigurations + A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-volumeconfigurations DuplicatesAllowed: True ItemType: VolumeConfiguration diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 index c64b04c38..8cd4a7366 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 @@ -1,10 +1,12 @@ function New-VSOpsWorksStack { <# .SYNOPSIS - Adds an AWS::OpsWorks::Stack resource to the template. + Adds an AWS::OpsWorks::Stack resource to the template. Creates a new stack. For more information, see Create a New Stack: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html. .DESCRIPTION - Adds an AWS::OpsWorks::Stack resource to the template. + Adds an AWS::OpsWorks::Stack resource to the template. Creates a new stack. For more information, see Create a New Stack: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html. + +**Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html @@ -13,11 +15,19 @@ function New-VSOpsWorksStack { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AgentVersion + The default AWS OpsWorks Stacks agent version. You have the following options: ++ Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. ++ Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. +The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions: https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. +You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-agentversion PrimitiveType: String UpdateType: Mutable .PARAMETER Attributes + One or more user-defined key-value pairs to be added to the stack attributes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-attributes DuplicatesAllowed: False PrimitiveItemType: String @@ -25,11 +35,15 @@ function New-VSOpsWorksStack { UpdateType: Mutable .PARAMETER ChefConfiguration + A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-chefconfiguration Type: ChefConfiguration UpdateType: Mutable .PARAMETER CloneAppIds + If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids DuplicatesAllowed: False PrimitiveItemType: String @@ -37,61 +51,96 @@ function New-VSOpsWorksStack { UpdateType: Immutable .PARAMETER ClonePermissions + If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions PrimitiveType: Boolean UpdateType: Immutable .PARAMETER ConfigurationManager + The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-configmanager Type: StackConfigurationManager UpdateType: Mutable .PARAMETER CustomCookbooksSource + Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html or Cookbooks and Recipes: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custcookbooksource Type: Source UpdateType: Mutable .PARAMETER CustomJson + A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: +"{"key1": "value1", "key2": "value2",...}" +For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custjson PrimitiveType: Json UpdateType: Mutable .PARAMETER DefaultAvailabilityZone + The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints: https://docs.aws.amazon.com/general/latest/gr/rande.html. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultaz PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultInstanceProfileArn + The Amazon Resource Name ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultinstanceprof PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultOs + The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following. ++ A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. ++ A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. ++ CentOS Linux 7 ++ Red Hat Enterprise Linux 7 ++ A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. ++ A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html. +The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultRootDeviceType + The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultrootdevicetype PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultSshKeyName + A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html and Managing SSH Access: https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html. You can override this setting by specifying a different key pair, or no key pair, when you create an instance: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultSubnetId + The stack's default subnet ID. All instances are launched into this subnet unless you specify another subnet ID when you create the instance. This parameter is required if you specify a value for the VpcId parameter. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#defaultsubnet PrimitiveType: String UpdateType: Mutable .PARAMETER EcsClusterArn + The Amazon Resource Name ARN of the Amazon Elastic Container Service Amazon ECS cluster to register with the AWS OpsWorks stack. +If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn PrimitiveType: String UpdateType: Mutable .PARAMETER ElasticIps + A list of Elastic IP addresses to register with the AWS OpsWorks stack. +If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips DuplicatesAllowed: False ItemType: ElasticIp @@ -99,16 +148,35 @@ function New-VSOpsWorksStack { UpdateType: Mutable .PARAMETER HostnameTheme + The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are: ++ Baked_Goods ++ Clouds ++ Europe_Cities ++ Fruits ++ Greek_Deities_and_Titans ++ Legendary_creatures_from_Japan ++ Planets_and_Moons ++ Roman_Deities ++ Scottish_Islands ++ US_Cities ++ Wild_Cats +To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-hostnametheme PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The stack name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-name PrimitiveType: String UpdateType: Mutable .PARAMETER RdsDbInstances + The Amazon Relational Database Service Amazon RDS DB instance to register with the AWS OpsWorks stack. +If you specify a DB instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances DuplicatesAllowed: False ItemType: RdsDbInstance @@ -116,16 +184,27 @@ function New-VSOpsWorksStack { UpdateType: Mutable .PARAMETER ServiceRoleArn + The stack's AWS Identity and Access Management IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name ARN for an existing IAM role. For more information about IAM ARNs, see Using Identifiers: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-servicerolearn PrimitiveType: String UpdateType: Immutable .PARAMETER SourceStackId + If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + A map that contains tag keys and tag values that are attached to a stack or layer. ++ The key cannot be empty. ++ The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / ++ The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / ++ Leading and trailing white spaces are trimmed from both the key and value. ++ A maximum of 40 tags is allowed for any resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-tags DuplicatesAllowed: True ItemType: Tag @@ -133,16 +212,33 @@ function New-VSOpsWorksStack { UpdateType: Mutable .PARAMETER UseCustomCookbooks + Whether the stack uses custom cookbooks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#usecustcookbooks PrimitiveType: Boolean UpdateType: Mutable .PARAMETER UseOpsworksSecurityGroups + Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. +AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings: ++ True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer default setting. You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. ++ False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. +For more information, see Create a New Stack: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-useopsworkssecuritygroups PrimitiveType: Boolean UpdateType: Mutable .PARAMETER VpcId + The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. ++ If your account supports EC2-Classic, the default value is no VPC. ++ If your account does not support EC2-Classic, the default value is the default VPC for the specified region. +If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. +If you specify a nondefault VPC ID, note the following: ++ It must belong to a VPC in your account that is in the specified region. ++ You must specify a value for DefaultSubnetId. +For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html. For more information about default VPC and EC2-Classic, see Supported Platforms: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 index 8c4954b8e..17d793752 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 @@ -1,10 +1,10 @@ function New-VSOpsWorksUserProfile { <# .SYNOPSIS - Adds an AWS::OpsWorks::UserProfile resource to the template. + Adds an AWS::OpsWorks::UserProfile resource to the template. Describes a user's SSH information. .DESCRIPTION - Adds an AWS::OpsWorks::UserProfile resource to the template. + Adds an AWS::OpsWorks::UserProfile resource to the template. Describes a user's SSH information. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html @@ -13,21 +13,29 @@ function New-VSOpsWorksUserProfile { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AllowSelfManagement + Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions: https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-allowselfmanagement PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IamUserArn + The user's IAM ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-iamuserarn PrimitiveType: String UpdateType: Immutable .PARAMETER SshPublicKey + The user's SSH public key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshpublickey PrimitiveType: String UpdateType: Mutable .PARAMETER SshUsername + The user's SSH user name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshusername PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 index ed0ad2213..0526fe92b 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 @@ -1,10 +1,10 @@ function New-VSOpsWorksVolume { <# .SYNOPSIS - Adds an AWS::OpsWorks::Volume resource to the template. + Adds an AWS::OpsWorks::Volume resource to the template. Describes an instance's Amazon EBS volume. .DESCRIPTION - Adds an AWS::OpsWorks::Volume resource to the template. + Adds an AWS::OpsWorks::Volume resource to the template. Describes an instance's Amazon EBS volume. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html @@ -13,21 +13,29 @@ function New-VSOpsWorksVolume { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Ec2VolumeId + The Amazon EC2 volume ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-ec2volumeid PrimitiveType: String UpdateType: Immutable .PARAMETER MountPoint + The volume mount point. For example, "/mnt/disk1". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-mountpoint PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The volume name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-name PrimitiveType: String UpdateType: Mutable .PARAMETER StackId + The stack ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-stackid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 index 5282638c8..6f3eb7247 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointADMChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::ADMChannel resource to the template. + Adds an AWS::Pinpoint::ADMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::ADMChannel resource to the template. + Adds an AWS::Pinpoint::ADMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. + +The ADM Channel resource represents the status and authentication settings for the ADM channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the ADM channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html @@ -13,21 +15,29 @@ function New-VSPinpointADMChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientSecret + The Client Secret that you received from Amazon to send messages by using ADM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientsecret PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the ADM channel for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ClientId + The Client ID that you received from Amazon to send messages by using ADM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientid PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier of the Amazon Pinpoint application that the ADM channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-applicationid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 index 01a59fb77..ccae5a266 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointAPNSChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSChannel resource to the template. + Adds an AWS::Pinpoint::APNSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint app. .DESCRIPTION - Adds an AWS::Pinpoint::APNSChannel resource to the template. + Adds an AWS::Pinpoint::APNSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint app. + +The APNs Channel resource represents the status and authentication settings for the APNs channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the APNs channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html @@ -13,46 +15,64 @@ function New-VSPinpointAPNSChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BundleId + The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-bundleid PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateKey + The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-privatekey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the APNs channel for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod + The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-defaultauthenticationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKey + The authentication key to use for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier of the Amazon Pinpoint application that the APNs channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId + The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate + The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId + The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 index 706151bea..c1208131d 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointAPNSSandboxChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. + Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint app. .DESCRIPTION - Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. + Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint app. + +The APNs Sandbox Channel resource represents the status and authentication settings of the APNs sandbox channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the APNs sandbox channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html @@ -13,46 +15,64 @@ function New-VSPinpointAPNSSandboxChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BundleId + The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-bundleid PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateKey + The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-privatekey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod + The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-defaultauthenticationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKey + The authentication key to use for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier of the Amazon Pinpoint application that the APNs sandbox channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId + The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate + The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId + The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 index 5c5473a60..a2285c71b 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointAPNSVoipChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. + Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint app. .DESCRIPTION - Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. + Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint app. + +The APNs VoIP Channel resource represents the status and authentication settings of the APNs VoIP channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the APNs VoIP channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html @@ -13,46 +15,64 @@ function New-VSPinpointAPNSVoipChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BundleId + The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-bundleid PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateKey + The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-privatekey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod + The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-defaultauthenticationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKey + The authentication key to use for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier of the Amazon Pinpoint application that the APNs VoIP channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId + The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate + The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId + The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 index 015760b8b..26ace7f79 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointAPNSVoipSandboxChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. + Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint app. .DESCRIPTION - Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. + Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint app. + +The APNs VoIP Sandbox Channel resource represents the status and authentication settings of the APNs VoIP sandbox channel for a specific app. You can use this resource to retrieve information about, update, or disable (delete the APNs VoIP sandbox channel for an app. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html @@ -13,46 +15,64 @@ function New-VSPinpointAPNSVoipSandboxChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BundleId + The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-bundleid PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateKey + The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-privatekey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether the APNs VoIP sandbox channel is enabled for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod + The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-defaultauthenticationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKey + The authentication key to use for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier for the application that the APNs VoIP sandbox channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId + The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate + The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId + The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkeyid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 index 1043321af..9e4295540 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointApp { <# .SYNOPSIS - Adds an AWS::Pinpoint::App resource to the template. + Adds an AWS::Pinpoint::App resource to the template. Specifies an app. In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of settings, customer information, segments, and campaigns. .DESCRIPTION - Adds an AWS::Pinpoint::App resource to the template. + Adds an AWS::Pinpoint::App resource to the template. Specifies an app. In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of settings, customer information, segments, and campaigns. + +You can use the App resource to retrieve information about or delete an existing application. To create a new application, use the Apps resource and send a POST request to the /apps URI. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html @@ -13,11 +15,15 @@ function New-VSPinpointApp { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The display name of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 index 36c3e9e09..fde449605 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointApplicationSettings { <# .SYNOPSIS - Adds an AWS::Pinpoint::ApplicationSettings resource to the template. + Adds an AWS::Pinpoint::ApplicationSettings resource to the template. Specifies the settings for an Amazon Pinpoint app. .DESCRIPTION - Adds an AWS::Pinpoint::ApplicationSettings resource to the template. + Adds an AWS::Pinpoint::ApplicationSettings resource to the template. Specifies the settings for an Amazon Pinpoint app. + +In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of settings, customer information, segments, and campaigns. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html @@ -13,26 +15,41 @@ function New-VSPinpointApplicationSettings { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER QuietTime + The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met: +- The EndpointDemographic.Timezone property of the endpoint is set to a valid value. +- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application or a campaign that has custom quiet time settings. +- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application or a campaign that has custom quiet time settings. +If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled. +To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign. + Type: QuietTime Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-quiettime UpdateType: Mutable .PARAMETER Limits + The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign. + Type: Limits Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-limits UpdateType: Mutable .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER CampaignHook + The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign. + Type: CampaignHook Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-campaignhook UpdateType: Mutable .PARAMETER CloudWatchMetricsEnabled + Specifies whether to enable application-related alarms in Amazon CloudWatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-cloudwatchmetricsenabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 index 4b396b348..a9d42f2be 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointBaiduChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::BaiduChannel resource to the template. + Adds an AWS::Pinpoint::BaiduChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu notification service. Before you use Amazon Pinpoint to send notifications to Baidu, you have to enable the Baidu channel for an Amazon Pinpoint app. .DESCRIPTION - Adds an AWS::Pinpoint::BaiduChannel resource to the template. + Adds an AWS::Pinpoint::BaiduChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu notification service. Before you use Amazon Pinpoint to send notifications to Baidu, you have to enable the Baidu channel for an Amazon Pinpoint app. + +The Baidu Channel resource represents the status and authentication settings of the Baidu channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the Baidu channel for an app. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html @@ -13,21 +15,29 @@ function New-VSPinpointBaiduChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretKey + The secret key that you received from the Baidu Cloud Push service to communicate with the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-secretkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApiKey + The API key that you received from the Baidu Cloud Push service to communicate with the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-apikey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the Baidu channel for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app that you're configuring the Baidu channel for. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-applicationid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 index 5ac105da4..5f2c10117 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointCampaign { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign resource to the template. + Adds an AWS::Pinpoint::Campaign resource to the template. Updates the settings for a campaign. .DESCRIPTION - Adds an AWS::Pinpoint::Campaign resource to the template. + Adds an AWS::Pinpoint::Campaign resource to the template. Updates the settings for a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html @@ -13,77 +13,107 @@ function New-VSPinpointCampaign { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The custom description of the campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description PrimitiveType: String UpdateType: Mutable .PARAMETER SegmentId + The unique identifier for the segment to associate with the campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentid PrimitiveType: String UpdateType: Mutable .PARAMETER IsPaused + Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AdditionalTreatments + An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments ItemType: WriteTreatmentResource UpdateType: Mutable .PARAMETER Name + The custom name of the campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name PrimitiveType: String UpdateType: Mutable .PARAMETER SegmentVersion + The version of the segment to associate with the campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentversion PrimitiveType: Integer UpdateType: Mutable .PARAMETER TreatmentDescription + The custom description of a variation of the campaign to use for A/B testing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription PrimitiveType: String UpdateType: Mutable .PARAMETER MessageConfiguration + The message configuration settings for the campaign. + Type: MessageConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration UpdateType: Mutable .PARAMETER Limits + The messaging limits for the campaign. + Type: Limits Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits UpdateType: Mutable .PARAMETER HoldoutPercent + The allocated percentage of users segment members who shouldn't receive messages from the campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-holdoutpercent PrimitiveType: Integer UpdateType: Mutable .PARAMETER Schedule + The schedule settings for the campaign. + Type: Schedule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule UpdateType: Mutable .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app that the campaign is associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER CampaignHook + Specifies the AWS Lambda function to use as a code hook for a campaign. + Type: CampaignHook Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook UpdateType: Mutable .PARAMETER Tags + The unique ID of the campaign. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER TreatmentName + The custom name of a variation of the campaign to use for A/B testing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 index edf10c9bc..9cc1e4fd3 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointEmailChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::EmailChannel resource to the template. + Adds an AWS::Pinpoint::EmailChannel resource to the template. Updates the status and settings of the email channel for an application. .DESCRIPTION - Adds an AWS::Pinpoint::EmailChannel resource to the template. + Adds an AWS::Pinpoint::EmailChannel resource to the template. Updates the status and settings of the email channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html @@ -13,31 +13,43 @@ function New-VSPinpointEmailChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConfigurationSet + The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API: emailAPIreference.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-configurationset PrimitiveType: String UpdateType: Mutable .PARAMETER FromAddress + The verified email address that you want to send email from when you send email through the channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-fromaddress PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the email channel for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app that you're specifying the email channel for. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER Identity + The Amazon Resource Name ARN of the identity, verified with Amazon Simple Email Service Amazon SES, that you want to use when you send email through the channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-identity PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The ARN of the AWS Identity and Access Management IAM role that you want Amazon Pinpoint to use when it submits email-related event data for the channel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 index 2baae322e..f5de8393b 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointEmailConfigurationSet { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSet resource to the template. + Adds an AWS::PinpointEmail::ConfigurationSet resource to the template. Create a configuration set. *Configuration sets* are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. .DESCRIPTION - Adds an AWS::PinpointEmail::ConfigurationSet resource to the template. + Adds an AWS::PinpointEmail::ConfigurationSet resource to the template. Create a configuration set. *Configuration sets* are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html @@ -13,32 +13,44 @@ function New-VSPinpointEmailConfigurationSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SendingOptions + An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set. + Type: SendingOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-sendingoptions UpdateType: Mutable .PARAMETER TrackingOptions + An object that defines the open and click tracking options for emails that you send using the configuration set. + Type: TrackingOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-trackingoptions UpdateType: Mutable .PARAMETER ReputationOptions + An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set. + Type: ReputationOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-reputationoptions UpdateType: Mutable .PARAMETER DeliveryOptions + An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. + Type: DeliveryOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-deliveryoptions UpdateType: Mutable .PARAMETER Tags + An object that defines the tags keys and values that you want to associate with the configuration set. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-tags ItemType: Tags UpdateType: Mutable .PARAMETER Name + The name of the configuration set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 index 941db4fee..e1f54a10d 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointEmailConfigurationSetEventDestination { <# .SYNOPSIS - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination resource to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination resource to the template. Create an event destination. In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. .DESCRIPTION - Adds an AWS::PinpointEmail::ConfigurationSetEventDestination resource to the template. + Adds an AWS::PinpointEmail::ConfigurationSetEventDestination resource to the template. Create an event destination. In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + +A single configuration set can include more than one event destination. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationseteventdestination.html @@ -13,16 +15,22 @@ function New-VSPinpointEmailConfigurationSetEventDestination { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EventDestinationName + The name of the event destination that you want to modify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationseteventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestinationname PrimitiveType: String UpdateType: Immutable .PARAMETER ConfigurationSetName + The name of the configuration set that contains the event destination that you want to modify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationseteventdestination.html#cfn-pinpointemail-configurationseteventdestination-configurationsetname PrimitiveType: String UpdateType: Immutable .PARAMETER EventDestination + An object that defines the event destination. + Type: EventDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationseteventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 index a4b92466a..5c62d793e 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointEmailDedicatedIpPool { <# .SYNOPSIS - Adds an AWS::PinpointEmail::DedicatedIpPool resource to the template. + Adds an AWS::PinpointEmail::DedicatedIpPool resource to the template. A request to create a new dedicated IP pool. .DESCRIPTION - Adds an AWS::PinpointEmail::DedicatedIpPool resource to the template. + Adds an AWS::PinpointEmail::DedicatedIpPool resource to the template. A request to create a new dedicated IP pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-dedicatedippool.html @@ -13,11 +13,15 @@ function New-VSPinpointEmailDedicatedIpPool { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PoolName + The name of the dedicated IP pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-dedicatedippool.html#cfn-pinpointemail-dedicatedippool-poolname PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + An object that defines the tags keys and values that you want to associate with the dedicated IP pool. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-dedicatedippool.html#cfn-pinpointemail-dedicatedippool-tags ItemType: Tags diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 index 85e51e83e..bf3cd5f71 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 @@ -1,10 +1,18 @@ function New-VSPinpointEmailIdentity { <# .SYNOPSIS - Adds an AWS::PinpointEmail::Identity resource to the template. + Adds an AWS::PinpointEmail::Identity resource to the template. Specifies an identity to use for sending email through Amazon Pinpoint. In Amazon Pinpoint, an *identity* is an email address or domain that you use when you send email. Before you can use Amazon Pinpoint to send an email from an identity, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the address or domain, and that you've given Amazon Pinpoint permission to send email from that identity. .DESCRIPTION - Adds an AWS::PinpointEmail::Identity resource to the template. + Adds an AWS::PinpointEmail::Identity resource to the template. Specifies an identity to use for sending email through Amazon Pinpoint. In Amazon Pinpoint, an *identity* is an email address or domain that you use when you send email. Before you can use Amazon Pinpoint to send an email from an identity, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the address or domain, and that you've given Amazon Pinpoint permission to send email from that identity. + +When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. + +When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process. + +**Important** + +When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html @@ -13,27 +21,40 @@ function New-VSPinpointEmailIdentity { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FeedbackForwardingEnabled + Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. +When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. +When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur even if this setting is disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html#cfn-pinpointemail-identity-feedbackforwardingenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DkimSigningEnabled + For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail DKIM signing for the domain. +If the value is true, then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the amazonses.com domain. If the value is false, then the messages that you send are only signed using the DKIM keys for the amazonses.com domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html#cfn-pinpointemail-identity-dkimsigningenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Tags + An object that defines the tags keys and values that you want to associate with the email identity. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html#cfn-pinpointemail-identity-tags ItemType: Tags UpdateType: Mutable .PARAMETER Name + The address or domain of the identity, such as *sender@example.com* or *example.co.uk*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html#cfn-pinpointemail-identity-name PrimitiveType: String UpdateType: Immutable .PARAMETER MailFromAttributes + Used to enable or disable the custom Mail-From domain configuration for an email identity. + Type: MailFromAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html#cfn-pinpointemail-identity-mailfromattributes UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 index d50671223..fe9dcb740 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointEventStream { <# .SYNOPSIS - Adds an AWS::Pinpoint::EventStream resource to the template. + Adds an AWS::Pinpoint::EventStream resource to the template. Creates a new event stream for an application or updates the settings of an existing event stream for an application. .DESCRIPTION - Adds an AWS::Pinpoint::EventStream resource to the template. + Adds an AWS::Pinpoint::EventStream resource to the template. Creates a new event stream for an application or updates the settings of an existing event stream for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html @@ -13,16 +13,24 @@ function New-VSPinpointEventStream { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app that you want to export data from. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER DestinationStreamArn + The Amazon Resource Name ARN of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to. +For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name +For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-destinationstreamarn PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The AWS Identity and Access Management IAM role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 index eb90a4fd1..30547fed5 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointGCMChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::GCMChannel resource to the template. + Adds an AWS::Pinpoint::GCMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM service, which replaced the Google Cloud Messaging (GCM service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::GCMChannel resource to the template. + Adds an AWS::Pinpoint::GCMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM service, which replaced the Google Cloud Messaging (GCM service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application. + +The GCM Channel resource represents the status and authentication settings of the GCM channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the GCM channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html @@ -13,16 +15,22 @@ function New-VSPinpointGCMChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApiKey + The API key, also called the *server key*, that you received from Google to communicate with Google services. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-apikey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the GCM channel for the Amazon Pinpoint application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier for the Amazon Pinpoint app that the GCM channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-applicationid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 index 3955cf5b1..3353b4a84 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointSMSChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::SMSChannel resource to the template. + Adds an AWS::Pinpoint::SMSChannel resource to the template. A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you use Amazon Pinpoint to send text messages, you have enable the SMS channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::SMSChannel resource to the template. + Adds an AWS::Pinpoint::SMSChannel resource to the template. A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you use Amazon Pinpoint to send text messages, you have enable the SMS channel for an Amazon Pinpoint application. + +The SMS Channel resource represents the status, sender ID, and other settings for the SMS channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the SMS channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html @@ -13,21 +15,31 @@ function New-VSPinpointSMSChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ShortCode + The registered short code that you want to use when you send messages through the SMS channel. +For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html in the *Amazon Pinpoint User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + Specifies whether to enable the SMS channel for the app. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId + The unique identifier for the Amazon Pinpoint app that the SMS channel applies to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER SenderId + The identity that you want to display on recipients' devices when they receive messages from the SMS channel. +SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html in the *Amazon Pinpoint User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-senderid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 index bf7ecbff4..307bda341 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointSegment { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment resource to the template. + Adds an AWS::Pinpoint::Segment resource to the template. Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. .DESCRIPTION - Adds an AWS::Pinpoint::Segment resource to the template. + Adds an AWS::Pinpoint::Segment resource to the template. Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html @@ -13,26 +13,36 @@ function New-VSPinpointSegment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SegmentGroups + The segment group, which consists of zero or more base segments, to use and the dimensions to apply to those base segments in order to build the segment. Your request can include only one segment group. + Type: SegmentGroups Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentgroups UpdateType: Mutable .PARAMETER Dimensions + The criteria that define the dimensions for the segment. + Type: SegmentDimensions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-dimensions UpdateType: Mutable .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app that the segment is associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The unique identifier for the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the segment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 index 2d052c0dc..e899383d6 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointVoiceChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::VoiceChannel resource to the template. + Adds an AWS::Pinpoint::VoiceChannel resource to the template. Updates the status and settings of the voice channel for an application. .DESCRIPTION - Adds an AWS::Pinpoint::VoiceChannel resource to the template. + Adds an AWS::Pinpoint::VoiceChannel resource to the template. Updates the status and settings of the voice channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html @@ -13,11 +13,15 @@ function New-VSPinpointVoiceChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Enabled + Specifies whether to enable the voice channel for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId + The unique ID of the Amazon Pinpoint app that you're setting up the voice channel for. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-applicationid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 b/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 index 134758eaf..5b4b5ca9b 100644 --- a/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 @@ -1,10 +1,10 @@ function New-VSRAMResourceShare { <# .SYNOPSIS - Adds an AWS::RAM::ResourceShare resource to the template. + Adds an AWS::RAM::ResourceShare resource to the template. Specifies a resource share. .DESCRIPTION - Adds an AWS::RAM::ResourceShare resource to the template. + Adds an AWS::RAM::ResourceShare resource to the template. Specifies a resource share. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html @@ -13,29 +13,39 @@ function New-VSRAMResourceShare { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Principals + The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-principals UpdateType: Mutable .PARAMETER AllowExternalPrincipals + Indicates whether principals outside your AWS organization can be associated with a resource share. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-allowexternalprincipals PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ResourceArns + The Amazon Resource Names ARN of the resources to associate with the resource share. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-resourcearns UpdateType: Mutable .PARAMETER Tags + One or more tags. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name of the resource share. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 index c5df3a415..fb76e871c 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 @@ -1,10 +1,16 @@ function New-VSRDSDBCluster { <# .SYNOPSIS - Adds an AWS::RDS::DBCluster resource to the template. + Adds an AWS::RDS::DBCluster resource to the template. The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. For more information, see Managing an Amazon Aurora DB Cluster: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Aurora.html in the *Amazon Aurora User Guide*. .DESCRIPTION - Adds an AWS::RDS::DBCluster resource to the template. + Adds an AWS::RDS::DBCluster resource to the template. The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. For more information, see Managing an Amazon Aurora DB Cluster: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Aurora.html in the *Amazon Aurora User Guide*. + +**Note** + +You can only create this resource in regions where Amazon Aurora is supported. + +The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html @@ -13,6 +19,8 @@ function New-VSRDSDBCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssociatedRoles + Provides a list of the AWS Identity and Access Management IAM roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles DuplicatesAllowed: False ItemType: DBClusterRole @@ -20,6 +28,8 @@ function New-VSRDSDBCluster { UpdateType: Mutable .PARAMETER AvailabilityZones + A list of Availability Zones AZs where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html in the *Amazon Aurora User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones DuplicatesAllowed: False PrimitiveItemType: String @@ -27,41 +37,70 @@ function New-VSRDSDBCluster { UpdateType: Immutable .PARAMETER BacktrackWindow + The target backtrack window, in seconds. To disable backtracking, set this value to 0. +Default: 0 +Constraints: ++ If specified, this value must be set to a number from 0 to 259,200 72 hours. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow PrimitiveType: Long UpdateType: Mutable .PARAMETER BackupRetentionPeriod + The number of days for which automated backups are retained. +Default: 1 +Constraints: ++ Must be a value from 1 to 35 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backuprententionperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER DBClusterIdentifier + The DB cluster identifier. This parameter is stored as a lowercase string. +Constraints: ++ Must contain from 1 to 63 letters, numbers, or hyphens. ++ First character must be a letter. ++ Can't end with a hyphen or contain two consecutive hyphens. +Example: my-cluster1 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER DBClusterParameterGroupName + The name of the DB cluster parameter group to associate with this DB cluster. +If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. +If this argument is omitted, default.aurora5.6 is used. If default.aurora5.6 is used, specifying aurora-mysql or aurora-postgresql for the Engine property might result in an error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER DBSubnetGroupName + A DB subnet group that you want to associate with this DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DatabaseName + The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints in the *Amazon RDS User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename PrimitiveType: String UpdateType: Immutable .PARAMETER DeletionProtection + A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EnableCloudwatchLogsExports + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch in the *Amazon Aurora User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports DuplicatesAllowed: False PrimitiveItemType: String @@ -74,91 +113,160 @@ function New-VSRDSDBCluster { UpdateType: Mutable .PARAMETER EnableIAMDatabaseAuthentication + A value that indicates whether to enable mapping of AWS Identity and Access Management IAM accounts to database accounts. By default, mapping is disabled. +For more information, see IAM Database Authentication: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html in the *Amazon Aurora User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Engine + The name of the database engine to be used for this DB cluster. +Valid Values: aurora for MySQL 5.6-compatible Aurora, aurora-mysql for MySQL 5.7-compatible Aurora, and aurora-postgresql + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine PrimitiveType: String UpdateType: Immutable .PARAMETER EngineMode + The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode PrimitiveType: String UpdateType: Immutable .PARAMETER EngineVersion + The version number of the database engine to use. +To list all of the available engine versions for aurora for MySQL 5.6-compatible Aurora, use the following command: +aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions].EngineVersion" +To list all of the available engine versions for aurora-mysql for MySQL 5.7-compatible Aurora, use the following command: +aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions].EngineVersion" +To list all of the available engine versions for aurora-postgresql, use the following command: +aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions].EngineVersion" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion PrimitiveType: String UpdateType: Immutable .PARAMETER KmsKeyId + The Amazon Resource Name ARN of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER MasterUserPassword + The master password for the DB instance. +If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUsername + The name of the master user for the DB cluster. +You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername PrimitiveType: String UpdateType: Immutable .PARAMETER Port + The port number on which the instances in the DB cluster accept connections. +Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port PrimitiveType: Integer UpdateType: Mutable .PARAMETER PreferredBackupWindow + The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora in the *Amazon Aurora User Guide.* +Constraints: ++ Must be in the format hh24:mi-hh24:mi. ++ Must be in Universal Coordinated Time UTC. ++ Must not conflict with the preferred maintenance window. ++ Must be at least 30 minutes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow PrimitiveType: String UpdateType: Mutable .PARAMETER PreferredMaintenanceWindow + The weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. +Format: ddd:hh24:mi-ddd:hh24:mi +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora in the *Amazon Aurora User Guide.* +Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. +Constraints: Minimum 30-minute window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER ReplicationSourceIdentifier + The Amazon Resource Name ARN of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER RestoreType + The type of restore to be performed. You can specify one of the following values: ++ full-copy - The new DB cluster is restored as a full copy of the source DB cluster. ++ copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. +Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. +If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype PrimitiveType: String UpdateType: Immutable .PARAMETER ScalingConfiguration + The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration Type: ScalingConfiguration UpdateType: Mutable .PARAMETER SnapshotIdentifier + The identifier for the DB snapshot or DB cluster snapshot to restore from. +You can use either the name or the Amazon Resource Name ARN to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. +After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. +Constraints: ++ Must match the identifier of an existing Snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER SourceDBClusterIdentifier + The identifier of the source DB cluster from which to restore. +Constraints: ++ Must match the identifier of an existing DBCluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER SourceRegion + The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion PrimitiveType: String UpdateType: Immutable .PARAMETER StorageEncrypted + Indicates whether the DB instance is encrypted. +If you specify the DBClusterIdentifier, DBSnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. +If you specify the KmsKeyId property, then you must enable encryption. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted PrimitiveType: Boolean UpdateType: Immutable .PARAMETER Tags + Tags to assign to the DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags DuplicatesAllowed: True ItemType: Tag @@ -166,11 +274,16 @@ function New-VSRDSDBCluster { UpdateType: Mutable .PARAMETER UseLatestRestorableTime + A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. +Constraints: Can't be specified if RestoreToTime parameter is provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime PrimitiveType: Boolean UpdateType: Immutable .PARAMETER VpcSecurityGroupIds + A list of EC2 VPC security groups to associate with this DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids DuplicatesAllowed: False PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 index b1d029bdd..f4cc03170 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 @@ -1,10 +1,14 @@ function New-VSRDSDBClusterParameterGroup { <# .SYNOPSIS - Adds an AWS::RDS::DBClusterParameterGroup resource to the template. + Adds an AWS::RDS::DBClusterParameterGroup resource to the template. The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Aurora.html in the *Amazon Aurora User Guide*. .DESCRIPTION - Adds an AWS::RDS::DBClusterParameterGroup resource to the template. + Adds an AWS::RDS::DBClusterParameterGroup resource to the template. The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Aurora.html in the *Amazon Aurora User Guide*. + +**Note** + +If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the instances are rebooting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html @@ -13,21 +17,29 @@ function New-VSRDSDBClusterParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A friendly description for this DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER Family + Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + Provides a list of parameters for the DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + Tags to assign to the DB cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 index f2b0621d9..12072ff37 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 @@ -1,10 +1,44 @@ function New-VSRDSDBInstance { <# .SYNOPSIS - Adds an AWS::RDS::DBInstance resource to the template. + Adds an AWS::RDS::DBInstance resource to the template. The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance. .DESCRIPTION - Adds an AWS::RDS::DBInstance resource to the template. + Adds an AWS::RDS::DBInstance resource to the template. The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance. + +**Important** + +If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html. + +**Updating DB Instances** + +When properties labeled "*Update requires:* Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance. + +**Important** + +We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure: + +Deactivate any applications that are using the DB instance so that there's no activity on the DB instance. + +Create a snapshot of the DB instance. For more information about creating DB snapshots, see Creating a DB snapshot: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html. + +If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use. + +After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, the DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted. + +Update the stack. + +For more information about updating other properties of this resource, see ModifyDBInstance: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html. For more information about updating stacks, see AWS CloudFormation Stacks Updates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html. + +**Deleting DB Instances** + +You can set a deletion policy for your DB instance to control how AWS CloudFormation handles the instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the instance, to *delete* the instance, or to *create a snapshot* of the instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property: + +1. For AWS::RDS::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance. + +1. For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance. + +For more information, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html @@ -13,16 +47,24 @@ function New-VSRDSDBInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AllocatedStorage + The amount of storage in gigabytes to be initially allocated for the database instance. +If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value in 1,000 IOPS increments, then you must also increase the AllocatedStorage value in 100-GB increments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allocatedstorage PrimitiveType: String UpdateType: Mutable .PARAMETER AllowMajorVersionUpgrade + Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. +Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allowmajorversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AssociatedRoles + The AWS Identity and Access Management IAM roles associated with the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-associatedroles DuplicatesAllowed: False ItemType: DBInstanceRole @@ -30,16 +72,30 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade + Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window. +Default: true + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-autominorversionupgrade PrimitiveType: Boolean UpdateType: Conditional .PARAMETER AvailabilityZone + The Availability Zone that the database instance will be created in. +Default: A random, system-chosen Availability Zone in the endpoint's region. +Example: us-east-1d +Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER BackupRetentionPeriod + The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. +Default: 1 +Constraints: ++ Must be a value from 0 to 8 ++ Cannot be set to 0 if the DB Instance is a master instance with read replicas + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-backupretentionperiod PrimitiveType: Integer UpdateType: Conditional @@ -50,41 +106,130 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER CharacterSetName + For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-charactersetname PrimitiveType: String UpdateType: Immutable .PARAMETER CopyTagsToSnapshot + A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. +**Amazon Aurora** +Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-copytagstosnapshot PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DBClusterIdentifier + The identifier of the DB cluster that the instance will belong to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER DBInstanceClass + The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html in the *Amazon RDS User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceclass PrimitiveType: String UpdateType: Mutable .PARAMETER DBInstanceIdentifier + A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER DBName + The meaning of this parameter differs according to the database engine you use. +If you specify the DBSnapshotIdentifier: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier property, AWS CloudFormation ignores this property. +If you restore DB instances from snapshots, this property doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. +**MySQL** +The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. +Constraints: ++ Must contain 1 to 64 letters or numbers. ++ Can't be a word reserved by the specified database engine +**MariaDB** +The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. +Constraints: ++ Must contain 1 to 64 letters or numbers. ++ Can't be a word reserved by the specified database engine +**PostgreSQL** +The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. +Constraints: ++ Must contain 1 to 63 letters, numbers, or underscores. ++ Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits 0-9. ++ Can't be a word reserved by the specified database engine +**Oracle** +The Oracle System ID SID of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. +Default: ORCL +Constraints: ++ Can't be longer than 8 characters +**SQL Server** +Not applicable. Must be null. +**Amazon Aurora** +The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. +Constraints: ++ Must contain 1 to 64 letters or numbers. ++ Can't be a word reserved by the specified database engine + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname PrimitiveType: String UpdateType: Immutable .PARAMETER DBParameterGroupName + The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html resource created in the template. +If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbparametergroupname PrimitiveType: String UpdateType: Conditional .PARAMETER DBSecurityGroups + A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. +If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the EC2VpcId property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. +If you specify this property, AWS CloudFormation sends only the following properties if specified to Amazon RDS during create operations: ++ AllocatedStorage ++ AutoMinorVersionUpgrade ++ AvailabilityZone ++ BackupRetentionPeriod ++ CharacterSetName ++ DBInstanceClass ++ DBName ++ DBParameterGroupName ++ DBSecurityGroups ++ DBSubnetGroupName ++ Engine ++ EngineVersion ++ Iops ++ LicenseModel ++ MasterUsername ++ MasterUserPassword ++ MultiAZ ++ OptionGroupName ++ PreferredBackupWindow ++ PreferredMaintenanceWindow +If you specify this property, AWS CloudFormation sends only the following properties if specified to Amazon RDS during updates: ++ AllocatedStorage ++ AutoMinorVersionUpgrade ++ AllowMajorVersionUpgrade ++ BackupRetentionPeriod ++ DBInstanceClass ++ DBParameterGroupName ++ DBSecurityGroups ++ DBInstanceIdentifier ++ EngineVersion ++ Iops ++ MasterUserPassword ++ MultiAZ ++ OptionGroupName ++ PreferredBackupWindow ++ PreferredMaintenanceWindow +All other properties are ignored. Specify a virtual private cloud VPC security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups DuplicatesAllowed: True PrimitiveItemType: String @@ -92,36 +237,56 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER DBSnapshotIdentifier + The name or Amazon Resource Name ARN of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. +By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value other than an empty string, AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. +Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties. For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the *Amazon RDS API Reference*. +After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, the DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted. +If you specify this property, you can't specify the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER DBSubnetGroupName + A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. +If there's no DB subnet group, then the instance isn't a VPC DB instance. +For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud VPC: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html in the *Amazon Relational Database Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER DeleteAutomatedBackups + A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deleteautomatedbackups PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DeletionProtection + A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deletionprotection PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Domain + For an Amazon RDS DB instance that's running Microsoft SQL Server, this parameter specifies the Active Directory directory ID to create the instance in. Amazon RDS uses Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html in the *Amazon RDS User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domain PrimitiveType: String UpdateType: Mutable .PARAMETER DomainIAMRoleName + Specify the name of the IAM role to be used when making API calls to the Directory Service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domainiamrolename PrimitiveType: String UpdateType: Mutable .PARAMETER EnableCloudwatchLogsExports + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs : https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch in the *Amazon Relational Database Service User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports DuplicatesAllowed: False PrimitiveItemType: String @@ -129,46 +294,100 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER EnableIAMDatabaseAuthentication + A value that indicates whether to enable mapping of AWS Identity and Access Management IAM accounts to database accounts. By default, mapping is disabled. +You can enable IAM database authentication for the following database engines: +**Amazon Aurora** +Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. +**MySQL** ++ For MySQL 5.6, minor version 5.6.34 or higher ++ For MySQL 5.7, minor version 5.7.16 or higher ++ For MySQL 8.0, minor version 8.0.16 or higher +**PostgreSQL** ++ For PostgreSQL 9.5, minor version 9.5.15 or higher ++ For PostgreSQL 9.6, minor version 9.6.11 or higher ++ PostgreSQL 10.6, 10.7, and 10.9 +For more information, see IAM Database Authentication for MySQL and PostgreSQL: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html in the *Amazon RDS User Guide.* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EnablePerformanceInsights + A value that indicates whether to enable Performance Insights for the DB instance. +For more information, see Using Amazon Performance Insights: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html in the *Amazon Relational Database Service User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Engine + The name of the database engine that you want to use for this DB instance. For valid values, see the Engine parameter of the CreateDBInstance: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html action in the *Amazon RDS API Reference*. +If you don't specify a value for the DBParameterGroupName property, the default DBParameterGroup for the specified engine is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engine PrimitiveType: String UpdateType: Immutable .PARAMETER EngineVersion + The version number of the database engine to use. +**MySQL** +Example: 5.1.42 +Type: String +**Oracle** +Example: 11.2.0.2.v2 +Type: String +**SQL Server** +Example: 10.50.2789.0.v1 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion PrimitiveType: String UpdateType: Conditional .PARAMETER Iops + The number of I/O operations per second IOPS that the database provisions. The value must be equal to or greater than 1000. +If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate IOPS to allocated storage. For example, you can provision an Oracle database instance with 1000 IOPS and 200 GB of storage a ratio of 5:1, or specify 2000 IOPS with 200 GB of storage a ratio of 10:1. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS in the *Amazon RDS User Guide*. +If you specify io1 for the StorageType property, then you must also specify the Iops property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER KmsKeyId + The ARN of the AWS Key Management Service AWS KMS master key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default master key. If you specify this property, you must set the StorageEncrypted property to true. +If you specify the SourceDBInstanceIdentifier property, the value is inherited from the source DB instance if the Read Replica is created in the same region. +If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. +If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html in the *Amazon RDS User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER LicenseModel + License model information for this DB instance. +If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-licensemodel PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUserPassword + The password for the master database user. Can be any printable ASCII character except "/", "", or "@". +Type: String +**MySQL** +Constraints: Must contain from 8 to 41 alphanumeric characters. +**Oracle** +Constraints: Must contain from 8 to 30 alphanumeric characters. +**SQL Server** +Constraints: Must contain from 8 to 128 alphanumeric characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masteruserpassword PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUsername + The master user name for the DB instance. +If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masterusername PrimitiveType: String UpdateType: Immutable @@ -179,51 +398,86 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER MonitoringInterval + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. +If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. +Valid Values: 0, 1, 5, 10, 15, 30, 60 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringinterval PrimitiveType: Integer UpdateType: Conditional .PARAMETER MonitoringRoleArn + The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling in the *Amazon RDS User Guide*. +If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER MultiAZ + Specifies whether the database instance is a multiple Availability Zone deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Amazon Aurora storage is replicated across all the Availability Zones and doesn't require the MultiAZ option to be set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-multiaz PrimitiveType: Boolean UpdateType: Mutable .PARAMETER OptionGroupName + Indicates that the DB Instance should be associated with the specified option group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-optiongroupname PrimitiveType: String UpdateType: Mutable .PARAMETER PerformanceInsightsKMSKeyId + The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name ARN, KMS key identifier, or the KMS key alias for the KMS encryption key. +If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightskmskeyid PrimitiveType: String UpdateType: Conditional .PARAMETER PerformanceInsightsRetentionPeriod + The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 2 years. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER Port + The port number on which the database accepts connections. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port PrimitiveType: String UpdateType: Immutable .PARAMETER PreferredBackupWindow + The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. +Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned. ++ **US-East Northern Virginia Region:** 03:00-11:00 UTC ++ **US-West Northern California Region:** 06:00-14:00 UTC ++ **EU Ireland Region:** 22:00-06:00 UTC ++ **Asia Pacific Singapore Region:** 14:00-22:00 UTC ++ **Asia Pacific Tokyo Region: ** 17:00-03:00 UTC +Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated UTC. Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredbackupwindow PrimitiveType: String UpdateType: Mutable .PARAMETER PreferredMaintenanceWindow + The weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. +Format: ddd:hh24:mi-ddd:hh24:mi +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow in the *Amazon RDS User Guide.* +This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. +Constraints: Minimum 30-minute window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredmaintenancewindow PrimitiveType: String UpdateType: Conditional .PARAMETER ProcessorFeatures + The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-processorfeatures DuplicatesAllowed: False ItemType: ProcessorFeature @@ -231,36 +485,64 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER PromotionTier + A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance in the *Amazon Aurora User Guide*. +Default: 1 +Valid Values: 0 - 15 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-promotiontier PrimitiveType: Integer UpdateType: Mutable .PARAMETER PubliclyAccessible + Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. +The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html in the *Amazon RDS API Reference*. +If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the *DependsOn* attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html. +If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html in the *Amazon RDS User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-publiclyaccessible PrimitiveType: Boolean UpdateType: Immutable .PARAMETER SourceDBInstanceIdentifier + If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas. For more information, see Working with Read Replicas: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html in the *Amazon Relational Database Service Developer Guide*. +The SourceDBInstanceIdentifier property determines whether a DB instance is a Read Replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB instance not a Read Replica. ++ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the Read Replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. ++ Read Replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a Read Replica. ++ If you specify SourceDBInstanceIdentifier, don't set the MultiAZ property to true, and don't specify the DBSnapshotIdentifier property. You can't deploy Read Replicas in multiple Availability Zones, and you can't create a Read Replica from a snapshot. ++ Don't set the BackupRetentionPeriod, DBName, MasterUsername, MasterUserPassword, and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for Read Replicas. ++ If the source DB instance is in a different region than the Read Replica, specify the source region in SourceRegion, and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier. For more information, see Constructing a Amazon RDS Amazon Resource Name ARN: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN in the *Amazon RDS User Guide*. ++ For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER SourceRegion + The ID of the region that contains the source DB instance for the Read Replica. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourceregion PrimitiveType: String UpdateType: Immutable .PARAMETER StorageEncrypted + A value that indicates whether the DB instance is encrypted. By default, it is not encrypted. +**Amazon Aurora** +Not applicable. The encryption for DB instances is managed by the DB cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storageencrypted PrimitiveType: Boolean UpdateType: Immutable .PARAMETER StorageType + Specifies storage type to be associated with the DB Instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storagetype PrimitiveType: String UpdateType: Conditional .PARAMETER Tags + Tags to assign to the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-tags DuplicatesAllowed: True ItemType: Tag @@ -268,16 +550,28 @@ function New-VSRDSDBInstance { UpdateType: Mutable .PARAMETER Timezone + The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-timezone PrimitiveType: String UpdateType: Immutable .PARAMETER UseDefaultProcessorFeatures + A value that indicates whether the DB instance class of the DB instance uses its default processor features. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures PrimitiveType: Boolean UpdateType: Mutable .PARAMETER VPCSecurityGroups + A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html resources created in the template. +If you set VPCSecurityGroups, you must not set https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups, and vice versa. +You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: ++ You can't revert to using an RDS security group after you establish a VPC security group membership. ++ When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. ++ To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups property. +To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 index c574ce97d..f279b5afb 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 @@ -1,10 +1,16 @@ function New-VSRDSDBParameterGroup { <# .SYNOPSIS - Adds an AWS::RDS::DBParameterGroup resource to the template. + Adds an AWS::RDS::DBParameterGroup resource to the template. The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family. .DESCRIPTION - Adds an AWS::RDS::DBParameterGroup resource to the template. + Adds an AWS::RDS::DBParameterGroup resource to the template. The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family. + +This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html resource. + +**Note** + +Applying a parameter group to a DB instance may require the instance to reboot, resulting in a database outage for the duration of the reboot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html @@ -13,16 +19,27 @@ function New-VSRDSDBParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Provides the customer-specified description for this DB Parameter Group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER Family + Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. +**MySQL** +Valid Values for Apply method: immediate | pending-reboot +You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots. +**Oracle** +Valid Values for Apply method: pending-reboot + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters DuplicatesAllowed: False PrimitiveItemType: String @@ -30,6 +47,8 @@ function New-VSRDSDBParameterGroup { UpdateType: Mutable .PARAMETER Tags + Tags to assign to the DB parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 index fa005f9cf..ead7df687 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 @@ -1,10 +1,16 @@ function New-VSRDSDBSecurityGroup { <# .SYNOPSIS - Adds an AWS::RDS::DBSecurityGroup resource to the template. + Adds an AWS::RDS::DBSecurityGroup resource to the template. The AWS::RDS::DBSecurityGroup resource creates or updates an Amazon RDS DB security group. .DESCRIPTION - Adds an AWS::RDS::DBSecurityGroup resource to the template. + Adds an AWS::RDS::DBSecurityGroup resource to the template. The AWS::RDS::DBSecurityGroup resource creates or updates an Amazon RDS DB security group. + +**Note** + +If you use DB security groups, the settings that you can specify for your DB instances are limited. For more information, see the DBSecurityGroups: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups property of the AWS::RDS::DBInstance resource. + +When you specify an AWS::RDS::DBSecurityGroup as an argument to the Ref function, AWS CloudFormation returns the value of the DBSecurityGroupName. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html @@ -13,6 +19,8 @@ function New-VSRDSDBSecurityGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBSecurityGroupIngress + Ingress rules to be applied to the DB security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-dbsecuritygroupingress DuplicatesAllowed: False ItemType: Ingress @@ -20,16 +28,23 @@ function New-VSRDSDBSecurityGroup { UpdateType: Mutable .PARAMETER EC2VpcId + The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to. +The EC2VpcId property is for backward compatibility with older regions, and is no longer recommended for providing security information to an RDS DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-ec2vpcid PrimitiveType: String UpdateType: Immutable .PARAMETER GroupDescription + Provides the description of the DB Security Group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Tags to assign to the DB security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 index de05ba4f0..30530f44e 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 @@ -1,10 +1,14 @@ function New-VSRDSDBSecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::RDS::DBSecurityGroupIngress resource to the template. + Adds an AWS::RDS::DBSecurityGroupIngress resource to the template. The AWS::RDS::DBSecurityGroupIngress resource enables ingress to a DB security group using one of two forms of authorization. First, you can add EC2 or VPC security groups to the DB security group if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. .DESCRIPTION - Adds an AWS::RDS::DBSecurityGroupIngress resource to the template. + Adds an AWS::RDS::DBSecurityGroupIngress resource to the template. The AWS::RDS::DBSecurityGroupIngress resource enables ingress to a DB security group using one of two forms of authorization. First, you can add EC2 or VPC security groups to the DB security group if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. + +This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html. + +For details about the settings for DB security group ingress, see AuthorizeDBSecurityGroupIngress: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html @@ -13,26 +17,36 @@ function New-VSRDSDBSecurityGroupIngress { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CIDRIP + The IP range to authorize. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-cidrip PrimitiveType: String UpdateType: Mutable .PARAMETER DBSecurityGroupName + The name of the DB Security Group to add authorization to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupId + Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupName + Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupOwnerId + AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 index b87ffbd15..e30664901 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSRDSDBSubnetGroup { <# .SYNOPSIS - Adds an AWS::RDS::DBSubnetGroup resource to the template. + Adds an AWS::RDS::DBSubnetGroup resource to the template. The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. .DESCRIPTION - Adds an AWS::RDS::DBSubnetGroup resource to the template. + Adds an AWS::RDS::DBSubnetGroup resource to the template. The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html @@ -13,16 +13,24 @@ function New-VSRDSDBSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBSubnetGroupDescription + The description for the DB Subnet Group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER DBSubnetGroupName + The name for the DB Subnet Group. This value is stored as a lowercase string. +Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". +Example: mySubnetgroup + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER SubnetIds + The EC2 Subnet IDs for the DB Subnet Group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-subnetids DuplicatesAllowed: False PrimitiveItemType: String @@ -30,6 +38,8 @@ function New-VSRDSDBSubnetGroup { UpdateType: Mutable .PARAMETER Tags + Tags to assign to the DB subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 index b37773b20..5e9f62443 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 @@ -1,10 +1,10 @@ function New-VSRDSEventSubscription { <# .SYNOPSIS - Adds an AWS::RDS::EventSubscription resource to the template. + Adds an AWS::RDS::EventSubscription resource to the template. The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS. For more information, see Using Amazon RDS Event Notification: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html in the *Amazon RDS User Guide*. .DESCRIPTION - Adds an AWS::RDS::EventSubscription resource to the template. + Adds an AWS::RDS::EventSubscription resource to the template. The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS. For more information, see Using Amazon RDS Event Notification: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html in the *Amazon RDS User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html @@ -13,11 +13,15 @@ function New-VSRDSEventSubscription { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Enabled + A Boolean value; set to **true** to activate the subscription, set to **false** to create the subscription but not active it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EventCategories + A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html topic in the Amazon RDS User Guide or by using the **DescribeEventCategories** action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories DuplicatesAllowed: False PrimitiveItemType: String @@ -25,11 +29,21 @@ function New-VSRDSEventSubscription { UpdateType: Mutable .PARAMETER SnsTopicArn + The Amazon Resource Name ARN of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn PrimitiveType: String UpdateType: Immutable .PARAMETER SourceIds + The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. +Constraints: ++ If SourceIds are supplied, SourceType must also be provided. ++ If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. ++ If the source type is a DB security group, a DBSecurityGroupName must be supplied. ++ If the source type is a DB parameter group, a DBParameterGroupName must be supplied. ++ If the source type is a DB Snapshot, a DBSnapshotIdentifier must be supplied. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids DuplicatesAllowed: True PrimitiveItemType: String @@ -37,6 +51,9 @@ function New-VSRDSEventSubscription { UpdateType: Mutable .PARAMETER SourceType + The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. +Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype PrimitiveType: String UpdateType: Conditional diff --git a/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 index f77f07c8e..6f9d8125b 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 @@ -1,10 +1,10 @@ function New-VSRDSOptionGroup { <# .SYNOPSIS - Adds an AWS::RDS::OptionGroup resource to the template. + Adds an AWS::RDS::OptionGroup resource to the template. The AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine. .DESCRIPTION - Adds an AWS::RDS::OptionGroup resource to the template. + Adds an AWS::RDS::OptionGroup resource to the template. The AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html @@ -13,16 +13,22 @@ function New-VSRDSOptionGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EngineName + Specifies the name of the engine that this option group should be associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename PrimitiveType: String UpdateType: Immutable .PARAMETER MajorEngineVersion + Specifies the major version of the engine that this option group should be associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion PrimitiveType: String UpdateType: Immutable .PARAMETER OptionConfigurations + A list of all available options + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations DuplicatesAllowed: True ItemType: OptionConfiguration @@ -30,11 +36,15 @@ function New-VSRDSOptionGroup { UpdateType: Immutable .PARAMETER OptionGroupDescription + The description of the option group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Tags to assign to the option group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 index fe67d6955..4319059d5 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 @@ -1,10 +1,12 @@ function New-VSRedshiftCluster { <# .SYNOPSIS - Adds an AWS::Redshift::Cluster resource to the template. + Adds an AWS::Redshift::Cluster resource to the template. Specifies a cluster. A *cluster* is a fully managed data warehouse that consists of a set of compute nodes. .DESCRIPTION - Adds an AWS::Redshift::Cluster resource to the template. + Adds an AWS::Redshift::Cluster resource to the template. Specifies a cluster. A *cluster* is a fully managed data warehouse that consists of a set of compute nodes. + +To create a cluster in Virtual Private Cloud (VPC, you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html in the *Amazon Redshift Cluster Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html @@ -13,31 +15,63 @@ function New-VSRedshiftCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AllowVersionUpgrade + If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. +When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. +Default: true + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AutomatedSnapshotRetentionPeriod + The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. +Default: 1 +Constraints: Must be a value from 0 to 35. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER AvailabilityZone + The EC2 Availability Zone AZ in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. +Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. +Example: us-east-1d +Constraint: The specified Availability Zone must be in the same region as the current endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone PrimitiveType: String UpdateType: Immutable .PARAMETER ClusterIdentifier + A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. +Constraints: ++ Must contain from 1 to 63 alphanumeric characters or hyphens. ++ Alphabetic characters must be lowercase. ++ First character must be a letter. ++ Cannot end with a hyphen or contain two consecutive hyphens. ++ Must be unique for all clusters within an AWS account. +Example: myexamplecluster + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER ClusterParameterGroupName + The name of the parameter group to be associated with this cluster. +Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html +Constraints: ++ Must be 1 to 255 alphanumeric characters or hyphens. ++ First character must be a letter. ++ Cannot end with a hyphen or contain two consecutive hyphens. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname PrimitiveType: String UpdateType: Mutable .PARAMETER ClusterSecurityGroups + A list of security groups to be associated with this cluster. +Default: The default cluster security group for Amazon Redshift. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups DuplicatesAllowed: True PrimitiveItemType: String @@ -45,46 +79,81 @@ function New-VSRedshiftCluster { UpdateType: Mutable .PARAMETER ClusterSubnetGroupName + The name of a cluster subnet group to be associated with this cluster. +If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname PrimitiveType: String UpdateType: Immutable .PARAMETER ClusterType + The type of the cluster. When cluster type is specified as ++ single-node, the **NumberOfNodes** parameter is not required. ++ multi-node, the **NumberOfNodes** parameter is required. +Valid Values: multi-node | single-node +Default: multi-node + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustertype PrimitiveType: String UpdateType: Mutable .PARAMETER ClusterVersion + The version of the Amazon Redshift engine software that you want to deploy on the cluster. +The version selected runs on all the nodes in the cluster. +Constraints: Only version 1.0 is currently available. +Example: 1.0 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion PrimitiveType: String UpdateType: Mutable .PARAMETER DBName + The name of the first database to be created when the cluster is created. +To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database: https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html in the Amazon Redshift Database Developer Guide. +Default: dev +Constraints: ++ Must contain 1 to 64 alphanumeric characters. ++ Must contain only lowercase letters. ++ Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html in the Amazon Redshift Database Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname PrimitiveType: String UpdateType: Immutable .PARAMETER ElasticIp + The Elastic IP EIP address for the cluster. +Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms in the Amazon Redshift Cluster Management Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip PrimitiveType: String UpdateType: Immutable .PARAMETER Encrypted + If true, the data in the cluster is encrypted at rest. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted PrimitiveType: Boolean UpdateType: Immutable .PARAMETER HsmClientCertificateIdentifier + Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER HsmConfigurationIdentifier + Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-HsmConfigurationIdentifier PrimitiveType: String UpdateType: Mutable .PARAMETER IamRoles + A list of AWS Identity and Access Management IAM roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name ARN format. You can supply up to 10 IAM roles in a single request. +A cluster can have up to 10 IAM roles associated with it at any time. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles DuplicatesAllowed: False PrimitiveItemType: String @@ -92,66 +161,115 @@ function New-VSRedshiftCluster { UpdateType: Mutable .PARAMETER KmsKeyId + The AWS Key Management Service KMS key ID of the encryption key that you want to use to encrypt data in the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER LoggingProperties + Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties Type: LoggingProperties UpdateType: Mutable .PARAMETER MasterUserPassword + The password associated with the master user account for the cluster that is being created. +Constraints: ++ Must be between 8 and 64 characters in length. ++ Must contain at least one uppercase letter. ++ Must contain at least one lowercase letter. ++ Must contain one number. ++ Can be any printable ASCII character ASCII code 33 to 126 except ' single quote, " double quote, , /, @, or space. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUsername + The user name associated with the master user account for the cluster that is being created. +Constraints: ++ Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC. ++ First character must be a letter. ++ Cannot be a reserved word. A list of reserved words can be found in Reserved Words: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html in the Amazon Redshift Database Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername PrimitiveType: String UpdateType: Immutable .PARAMETER NodeType + The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes in the *Amazon Redshift Cluster Management Guide*. +Valid Values: ds2.xlarge | ds2.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype PrimitiveType: String UpdateType: Mutable .PARAMETER NumberOfNodes + The number of compute nodes in the cluster. This parameter is required when the **ClusterType** parameter is specified as multi-node. +For information about determining how many nodes you need, go to Working with Clusters: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes in the *Amazon Redshift Cluster Management Guide*. +If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. +Default: 1 +Constraints: Value must be at least 1 and no more than 100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype PrimitiveType: Integer UpdateType: Mutable .PARAMETER OwnerAccount + The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount PrimitiveType: String UpdateType: Immutable .PARAMETER Port + The port number on which the cluster accepts incoming connections. +The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. +Default: 5439 +Valid Values: 1150-65535 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port PrimitiveType: Integer UpdateType: Immutable .PARAMETER PreferredMaintenanceWindow + The weekly time range in UTC during which automated cluster maintenance can occur. +Format: ddd:hh24:mi-ddd:hh24:mi +Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows in Amazon Redshift Cluster Management Guide. +Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun +Constraints: Minimum 30-minute window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow PrimitiveType: String UpdateType: Mutable .PARAMETER PubliclyAccessible + If true, the cluster can be accessed from a public network. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SnapshotClusterIdentifier + The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER SnapshotIdentifier + The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. +Example: my-snapshot-id + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + A list of tag instances. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags DuplicatesAllowed: True ItemType: Tag @@ -159,6 +277,9 @@ function New-VSRedshiftCluster { UpdateType: Mutable .PARAMETER VpcSecurityGroupIds + A list of Virtual Private Cloud VPC security groups to be associated with the cluster. +Default: The default VPC security group is associated with the cluster. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 index 5f344a33e..99100fad8 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 @@ -1,10 +1,10 @@ function New-VSRedshiftClusterParameterGroup { <# .SYNOPSIS - Adds an AWS::Redshift::ClusterParameterGroup resource to the template. + Adds an AWS::Redshift::ClusterParameterGroup resource to the template. Describes a parameter group. .DESCRIPTION - Adds an AWS::Redshift::ClusterParameterGroup resource to the template. + Adds an AWS::Redshift::ClusterParameterGroup resource to the template. Describes a parameter group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html @@ -13,16 +13,24 @@ function New-VSRedshiftClusterParameterGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER ParameterGroupFamily + The name of the cluster parameter group family that this cluster parameter group is compatible with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupfamily PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters + An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. +For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. +For the workload management WLM configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parameters DuplicatesAllowed: True ItemType: Parameter @@ -30,6 +38,8 @@ function New-VSRedshiftClusterParameterGroup { UpdateType: Mutable .PARAMETER Tags + The list of tags for the cluster parameter group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 index 49752c097..a44ff00c3 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 @@ -1,10 +1,12 @@ function New-VSRedshiftClusterSecurityGroup { <# .SYNOPSIS - Adds an AWS::Redshift::ClusterSecurityGroup resource to the template. + Adds an AWS::Redshift::ClusterSecurityGroup resource to the template. Specifies a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. .DESCRIPTION - Adds an AWS::Redshift::ClusterSecurityGroup resource to the template. + Adds an AWS::Redshift::ClusterSecurityGroup resource to the template. Specifies a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. + +For information about managing security groups, go to Amazon Redshift Cluster Security Groups: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html in the *Amazon Redshift Cluster Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html @@ -13,11 +15,15 @@ function New-VSRedshiftClusterSecurityGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Specifies an arbitrary set of tags key–value pairs to associate with this security group. Use tags to manage your resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 index f76333a9c..d5015dc17 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 @@ -1,10 +1,16 @@ function New-VSRedshiftClusterSecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::Redshift::ClusterSecurityGroupIngress resource to the template. + Adds an AWS::Redshift::ClusterSecurityGroupIngress resource to the template. Adds an inbound (ingress rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR/Internet Protocol (IP range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. .DESCRIPTION - Adds an AWS::Redshift::ClusterSecurityGroupIngress resource to the template. + Adds an AWS::Redshift::ClusterSecurityGroupIngress resource to the template. Adds an inbound (ingress rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR/Internet Protocol (IP range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. + +If you authorize access to an Amazon EC2 security group, specify *EC2SecurityGroupName* and *EC2SecurityGroupOwnerId*. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. + +If you authorize access to a CIDR/IP address range, specify *CIDRIP*. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing: http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. + +You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html in the *Amazon Redshift Cluster Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html @@ -13,21 +19,31 @@ function New-VSRedshiftClusterSecurityGroupIngress { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CIDRIP + The IP range to be added the Amazon Redshift security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-cidrip PrimitiveType: String UpdateType: Immutable .PARAMETER ClusterSecurityGroupName + The name of the security group to which the ingress rule is added. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-clustersecuritygroupname PrimitiveType: String UpdateType: Immutable .PARAMETER EC2SecurityGroupName + The EC2 security group to be added the Amazon Redshift security group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-ec2securitygroupname PrimitiveType: String UpdateType: Immutable .PARAMETER EC2SecurityGroupOwnerId + The AWS account number of the owner of the security group specified by the *EC2SecurityGroupName* parameter. The AWS Access Key ID is not an acceptable value. +Example: 111122223333 +Conditional. If you specify the EC2SecurityGroupName property, you must specify this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-ec2securitygroupownerid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 index ee18742de..cb37a824e 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 @@ -1,10 +1,12 @@ function New-VSRedshiftClusterSubnetGroup { <# .SYNOPSIS - Adds an AWS::Redshift::ClusterSubnetGroup resource to the template. + Adds an AWS::Redshift::ClusterSubnetGroup resource to the template. Specifies an Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC when creating Amazon Redshift subnet group. .DESCRIPTION - Adds an AWS::Redshift::ClusterSubnetGroup resource to the template. + Adds an AWS::Redshift::ClusterSubnetGroup resource to the template. Specifies an Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC when creating Amazon Redshift subnet group. + +For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html in the *Amazon Redshift Cluster Management Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html @@ -13,11 +15,15 @@ function New-VSRedshiftClusterSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the subnet group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds + An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-subnetids DuplicatesAllowed: True PrimitiveItemType: String @@ -25,6 +31,8 @@ function New-VSRedshiftClusterSubnetGroup { UpdateType: Mutable .PARAMETER Tags + Specifies an arbitrary set of tags key–value pairs to associate with this subnet group. Use tags to manage your resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 index 4cd588de8..869fea86f 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 @@ -1,10 +1,10 @@ function New-VSRoboMakerFleet { <# .SYNOPSIS - Adds an AWS::RoboMaker::Fleet resource to the template. + Adds an AWS::RoboMaker::Fleet resource to the template. The AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments. .DESCRIPTION - Adds an AWS::RoboMaker::Fleet resource to the template. + Adds an AWS::RoboMaker::Fleet resource to the template. The AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html @@ -13,11 +13,15 @@ function New-VSRoboMakerFleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + The list of all tags added to the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 index e565f8d30..f2870c452 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 @@ -1,10 +1,10 @@ function New-VSRoboMakerRobot { <# .SYNOPSIS - Adds an AWS::RoboMaker::Robot resource to the template. + Adds an AWS::RoboMaker::Robot resource to the template. The AWS::RoboMaker::RobotApplication resource creates an AWS RoboMaker robot. .DESCRIPTION - Adds an AWS::RoboMaker::Robot resource to the template. + Adds an AWS::RoboMaker::Robot resource to the template. The AWS::RoboMaker::RobotApplication resource creates an AWS RoboMaker robot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html @@ -13,26 +13,36 @@ function New-VSRoboMakerRobot { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Fleet + The Amazon Resource Name ARN of the fleet to which the robot will be registered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-fleet PrimitiveType: String UpdateType: Immutable .PARAMETER Architecture + The architecture of the robot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-architecture PrimitiveType: String UpdateType: Immutable .PARAMETER GreengrassGroupId + The Greengrass group associated with the robot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-greengrassgroupid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + A map that contains tag keys and tag values that are attached to the robot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the robot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 index 52f1b5fcc..4d6a8f6e4 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 @@ -1,10 +1,10 @@ function New-VSRoboMakerRobotApplication { <# .SYNOPSIS - Adds an AWS::RoboMaker::RobotApplication resource to the template. + Adds an AWS::RoboMaker::RobotApplication resource to the template. The AWS::RoboMaker::RobotApplication resource creates an AWS RoboMaker robot application. .DESCRIPTION - Adds an AWS::RoboMaker::RobotApplication resource to the template. + Adds an AWS::RoboMaker::RobotApplication resource to the template. The AWS::RoboMaker::RobotApplication resource creates an AWS RoboMaker robot application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html @@ -13,27 +13,37 @@ function New-VSRoboMakerRobotApplication { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CurrentRevisionId + The current revision id. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-currentrevisionid PrimitiveType: String UpdateType: Mutable .PARAMETER RobotSoftwareSuite + The robot software suite used by the robot application. + Type: RobotSoftwareSuite Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-robotsoftwaresuite UpdateType: Immutable .PARAMETER Sources + The sources of the robot application. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-sources ItemType: SourceConfig UpdateType: Mutable .PARAMETER Tags + A map that contains tag keys and tag values that are attached to the robot application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the robot application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 index 27721beb1..191121a64 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 @@ -1,10 +1,10 @@ function New-VSRoboMakerRobotApplicationVersion { <# .SYNOPSIS - Adds an AWS::RoboMaker::RobotApplicationVersion resource to the template. + Adds an AWS::RoboMaker::RobotApplicationVersion resource to the template. The AWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker robot version. .DESCRIPTION - Adds an AWS::RoboMaker::RobotApplicationVersion resource to the template. + Adds an AWS::RoboMaker::RobotApplicationVersion resource to the template. The AWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker robot version. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplicationversion.html @@ -13,11 +13,15 @@ function New-VSRoboMakerRobotApplicationVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CurrentRevisionId + The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplicationversion.html#cfn-robomaker-robotapplicationversion-currentrevisionid PrimitiveType: String UpdateType: Immutable .PARAMETER Application + The application information for the robot application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplicationversion.html#cfn-robomaker-robotapplicationversion-application PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 index 5059c8b9b..d4e1d03a9 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 @@ -1,10 +1,10 @@ function New-VSRoboMakerSimulationApplication { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplication resource to the template. + Adds an AWS::RoboMaker::SimulationApplication resource to the template. The AWS::RoboMaker::SimulationApplication resource creates an AWS RoboMaker simulation application. .DESCRIPTION - Adds an AWS::RoboMaker::SimulationApplication resource to the template. + Adds an AWS::RoboMaker::SimulationApplication resource to the template. The AWS::RoboMaker::SimulationApplication resource creates an AWS RoboMaker simulation application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html @@ -13,37 +13,51 @@ function New-VSRoboMakerSimulationApplication { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RenderingEngine + The rendering engine for the simulation application. + Type: RenderingEngine Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-renderingengine UpdateType: Immutable .PARAMETER SimulationSoftwareSuite + The simulation software suite used by the simulation application. + Type: SimulationSoftwareSuite Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-simulationsoftwaresuite UpdateType: Immutable .PARAMETER CurrentRevisionId + The current revision id. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-currentrevisionid PrimitiveType: String UpdateType: Mutable .PARAMETER RobotSoftwareSuite + The robot software suite of the simulation application. + Type: RobotSoftwareSuite Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-robotsoftwaresuite UpdateType: Immutable .PARAMETER Sources + The sources of the simulation application. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-sources ItemType: SourceConfig UpdateType: Mutable .PARAMETER Tags + A map that contains tag keys and tag values that are attached to the simulation application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the simulation application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 index 0b2dceeba..9d3a04aea 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 @@ -1,10 +1,10 @@ function New-VSRoboMakerSimulationApplicationVersion { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplicationVersion resource to the template. + Adds an AWS::RoboMaker::SimulationApplicationVersion resource to the template. The AWS::RoboMaker::SimulationApplicationVersion resource creates a version of an AWS RoboMaker simulation application. .DESCRIPTION - Adds an AWS::RoboMaker::SimulationApplicationVersion resource to the template. + Adds an AWS::RoboMaker::SimulationApplicationVersion resource to the template. The AWS::RoboMaker::SimulationApplicationVersion resource creates a version of an AWS RoboMaker simulation application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplicationversion.html @@ -13,11 +13,15 @@ function New-VSRoboMakerSimulationApplicationVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CurrentRevisionId + The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplicationversion.html#cfn-robomaker-simulationapplicationversion-currentrevisionid PrimitiveType: String UpdateType: Immutable .PARAMETER Application + The application information for the simulation application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplicationversion.html#cfn-robomaker-simulationapplicationversion-application PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 index 8bbca2735..10f48139e 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 @@ -1,10 +1,26 @@ function New-VSRoute53HealthCheck { <# .SYNOPSIS - Adds an AWS::Route53::HealthCheck resource to the template. + Adds an AWS::Route53::HealthCheck resource to the template. The AWS::Route53::HealthCheck resource is a Route 53 resource type that contains settings for a Route 53 health check. .DESCRIPTION - Adds an AWS::Route53::HealthCheck resource to the template. + Adds an AWS::Route53::HealthCheck resource to the template. The AWS::Route53::HealthCheck resource is a Route 53 resource type that contains settings for a Route 53 health check. + +For information about associating health checks with resource record sets, see HealthCheckId: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId in ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html. + +**ELB Load Balancers** + +If you're registering EC2 instances with an Elastic Load Balancing (ELB load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check. + +**Private Hosted Zones** + +You can associate health checks with failover resource record sets in a private hosted zone. Note the following: + ++ Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC. + ++ You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server. + ++ You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html @@ -13,11 +29,15 @@ function New-VSRoute53HealthCheck { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER HealthCheckConfig + A complex type that contains detailed information about one health check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig Type: HealthCheckConfig UpdateType: Mutable .PARAMETER HealthCheckTags + The HealthCheckTags property describes key-value pairs that are associated with an AWS::Route53::HealthCheck resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags DuplicatesAllowed: True ItemType: HealthCheckTag diff --git a/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 index fc6bd4764..7ba4781d6 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 @@ -1,10 +1,32 @@ function New-VSRoute53HostedZone { <# .SYNOPSIS - Adds an AWS::Route53::HostedZone resource to the template. + Adds an AWS::Route53::HostedZone resource to the template. The AWS::Route53::HostedZone resource is a Route 53 resource type that contains information about how you want to route traffic for a domain (example.com and its subdomains (acme.example.com, zenith.example.com: .DESCRIPTION - Adds an AWS::Route53::HostedZone resource to the template. + Adds an AWS::Route53::HostedZone resource to the template. The AWS::Route53::HostedZone resource is a Route 53 resource type that contains information about how you want to route traffic for a domain (example.com and its subdomains (acme.example.com, zenith.example.com: + ++ Records in a public hosted zone define how you want to route traffic on the internet. + ++ Records in a private hosted zone define how you want to route traffic within one or more Amazon Virtual Private Clouds (Amazon VPCs. + +**Important** + +You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. + +For more information about charges for hosted zones, see Amazon Route 53 Pricing: http://aws.amazon.com/route53/pricing/. + +Note the following: + ++ You can't create a hosted zone for a top-level domain (TLD such as .com. + ++ For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html in the *Amazon Route 53 Developer Guide*. + +If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element. + ++ If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Making Amazon Route 53 the DNS Service for an Existing Domain: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html in the *Amazon Route 53 Developer Guide*. + +When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html @@ -13,11 +35,19 @@ function New-VSRoute53HostedZone { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER HostedZoneConfig + Optional A complex type that contains the following optional values: ++ For public and private hosted zones, an optional comment ++ For private hosted zones, an optional PrivateZone element +If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig Type: HostedZoneConfig UpdateType: Mutable .PARAMETER HostedZoneTags + Adds, edits, or deletes tags for a health check or a hosted zone. +For information about using tags for cost allocation, see Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html in the *AWS Billing and Cost Management User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags DuplicatesAllowed: True ItemType: HostedZoneTag @@ -25,16 +55,56 @@ function New-VSRoute53HostedZone { UpdateType: Mutable .PARAMETER Name + The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* without a trailing dot and *www.example.com.* with a trailing dot as identical. +If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name PrimitiveType: String UpdateType: Immutable .PARAMETER QueryLoggingConfig + Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. +DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: ++ Route 53 edge location that responded to the DNS query ++ Domain or subdomain that was requested ++ DNS record type, such as A or AAAA ++ DNS response code, such as NoError or ServFail +Log Group and Resource Policy +Before you create a query logging configuration, perform the following operations. +If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. +1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: ++ You must create the log group in the us-east-1 region. ++ You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for. ++ When you create log groups for query logging, we recommend that you use a consistent prefix, for example: +/aws/route53/hosted zone name +In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. +1. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: +arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* +**Note** +You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI. +Log Streams and Edge Locations +When Route 53 finishes creating the configuration for DNS query logging, it does the following: ++ Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. ++ Begins to send query logs to the applicable log stream. +The name of each log stream is in the following format: + hosted zone ID/edge location code +The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. These abbreviations might change in the future. For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details: http://aws.amazon.com/route53/details/ page. +Queries That Are Logged +Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query such as the IP address for a load balancer for example.com, the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html in the *Amazon Route 53 Developer Guide*. +Log File Format +For a list of the values in each query log and the format of each value, see Logging DNS Queries: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html in the *Amazon Route 53 Developer Guide*. +Pricing +For information about charges for query logs, see Amazon CloudWatch Pricing: http://aws.amazon.com/cloudwatch/pricing/. +How to Stop Logging +If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig: https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig Type: QueryLoggingConfig UpdateType: Mutable .PARAMETER VPCs + A complex type that contains information about the VPCs that are associated with the specified hosted zone. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs DuplicatesAllowed: True ItemType: VPC diff --git a/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 index 78e058a7b..f2bf009f9 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 @@ -1,10 +1,12 @@ function New-VSRoute53RecordSet { <# .SYNOPSIS - Adds an AWS::Route53::RecordSet resource to the template. + Adds an AWS::Route53::RecordSet resource to the template. Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. .DESCRIPTION - Adds an AWS::Route53::RecordSet resource to the template. + Adds an AWS::Route53::RecordSet resource to the template. Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. + +For more information, see ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html in the *Amazon Route 53 API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html @@ -13,56 +15,157 @@ function New-VSRoute53RecordSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AliasTarget + *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. +If you're creating resource records sets for a private hosted zone, note the following: ++ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. ++ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. ++ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget Type: AliasTarget UpdateType: Mutable .PARAMETER Comment + *Optional:* Any comments you want to include about a change batch request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment PrimitiveType: String UpdateType: Mutable .PARAMETER Failover + *Failover resource record sets only:* To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set. +Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets: ++ When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set. ++ When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set. ++ When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set. ++ If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint. +You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets. +For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true. +For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: ++ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover PrimitiveType: String UpdateType: Mutable .PARAMETER GeoLocation + *Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF. +Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported. +If you create separate resource record sets for overlapping geographic regions for example, one resource record set for a continent and one for a country on the same continent, priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. +You can't create two geolocation resource record sets that specify the same geographic location. +The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements. +Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. +You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation Type: GeoLocation UpdateType: Mutable .PARAMETER HealthCheckId + If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check. +Route 53 determines whether a resource record set is healthy based on one of the following: ++ By periodically sending a request to the endpoint that is specified in the health check ++ By aggregating the status of a specified group of health checks calculated health checks ++ By determining the current state of a CloudWatch alarm CloudWatch metric health checks +Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. +For more information, see the following topics in the *Amazon Route 53 Developer Guide*: ++ How Amazon Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html ++ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html +**When to Specify HealthCheckId** +Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: ++ **Non-alias resource record sets**: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type such as multiple weighted records named www.example.com with a type of A and you specify health check IDs for all the resource record sets. +If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. +If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. +If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. ++ **Alias resource record sets**: You specify the following settings: ++ You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type such as multiple weighted records named www.example.com with a type of A. ++ You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone. ++ You specify a health check ID for the non-alias resource record set. +If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with. +If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set. +**Note** +The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets. +**Geolocation Routing** +For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy: ++ The United States ++ North America ++ The default resource record set +**Specifying the Health Check Endpoint by Domain Name** +If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server such as us-east-2-www.example.com, not the name of the resource record sets www.example.com. +Health check results will be unpredictable if you do the following: ++ Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set. ++ Associate that health check with the resource record set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid PrimitiveType: String UpdateType: Mutable .PARAMETER HostedZoneId + The ID of the hosted zone that contains the resource record sets that you want to change. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid PrimitiveType: String UpdateType: Immutable .PARAMETER HostedZoneName + The name of the domain for the hosted zone where you want to add the resource record set. +When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. +If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using HostedZoneId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename PrimitiveType: String UpdateType: Immutable .PARAMETER MultiValueAnswer + *Multivalue answer resource record sets only*: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following: ++ If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy. ++ If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy. ++ Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records. ++ If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records. ++ When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records. ++ If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response. +You can't create multivalue answer alias records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. +**ChangeResourceRecordSets Only** +Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com without a trailing dot and www.example.com. with a trailing dot as identical. +For information about how to specify characters other than a-z, 0-9, and - hyphen and how to specify internationalized domain names, see DNS Domain Name Format: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html in the *Amazon Route 53 Developer Guide*. +You can use the asterisk * wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following: ++ The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com. ++ The * can't replace any of the middle labels, for example, marketing.*.example.com. ++ If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character ASCII 42, not as a wildcard. +**Important** +You can't use the * wildcard for resource records sets that have a type of NS. +You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name PrimitiveType: String UpdateType: Immutable .PARAMETER Region + *Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. +Creating latency and latency alias resource record sets in private hosted zones is not supported. +When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. +Note the following: ++ You can only specify one ResourceRecord per latency resource record set. ++ You can only create one latency resource record set for each Amazon EC2 Region. ++ You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for. ++ You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceRecords + Information about the resource record sets that you want to add to the hosted zone. Each record should be in the format appropriate for the record type specified by the Type property. For information about different record types and their record formats, see Values That You Specify When You Create or Edit Amazon Route 53 Records: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords DuplicatesAllowed: True PrimitiveItemType: String @@ -70,21 +173,55 @@ function New-VSRoute53RecordSet { UpdateType: Mutable .PARAMETER SetIdentifier + *Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set. +For information about routing policies, see Choosing a Routing Policy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER TTL + The resource record cache time to live TTL, in seconds. Note the following: ++ If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target. ++ If you're associating this resource record set with a health check if you're adding a HealthCheckId element, we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status. ++ All of the resource record sets in a group of weighted resource record sets must have the same value for TTL. ++ If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds the TTL for load balancers will change the effect of the values that you specify for Weight. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. +Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT +Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. +Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT +SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, *Sender Policy Framework SPF for Authorizing Use of Domains in Email, Version 1*, has been updated to say, "...I]ts existence and mechanism defined in RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type: http://tools.ietf.org/html/rfc7208#section-14.1. +Values for alias resource record sets: ++ **Amazon API Gateway custom regional APIs and edge-optimized APIs:** A ++ **CloudFront distributions:** A +If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA. ++ **AWS Elastic Beanstalk environment that has a regionalized subdomain**: A ++ **ELB load balancers:** A | AAAA ++ **Amazon S3 buckets:** A ++ **Amazon Virtual Private Cloud interface VPC endpoints** A ++ **Another resource record set in this hosted zone:** Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA. +**Note** +If you're creating an alias record that has the same name as the hosted zone known as the zone apex, you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type PrimitiveType: String UpdateType: Mutable .PARAMETER Weight + *Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following: ++ You must specify a value for the Weight element for every weighted resource record set. ++ You can only specify one ResourceRecord per weighted resource record set. ++ You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets. ++ You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements. ++ For weighted but not weighted alias resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. +The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html in the *Amazon Route 53 Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 index 695bf3a0f..1a841b7c7 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSRoute53RecordSetGroup { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup resource to the template. + Adds an AWS::Route53::RecordSetGroup resource to the template. A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the resource record sets that you want to add, update, or delete. .DESCRIPTION - Adds an AWS::Route53::RecordSetGroup resource to the template. + Adds an AWS::Route53::RecordSetGroup resource to the template. A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the resource record sets that you want to add, update, or delete. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html @@ -13,21 +13,29 @@ function New-VSRoute53RecordSetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Comment + *Optional:* Any comments you want to include about a change batch request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment PrimitiveType: String UpdateType: Mutable .PARAMETER HostedZoneId + The ID of the hosted zone that contains the resource record sets that you want to change. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid PrimitiveType: String UpdateType: Immutable .PARAMETER HostedZoneName + The name of the hosted zone that you want to create, update, or delete resource record sets in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename PrimitiveType: String UpdateType: Immutable .PARAMETER RecordSets + A complex type that contains one RecordSet element for each resource record set that you want to add, update, or delete. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets DuplicatesAllowed: False ItemType: RecordSet diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 index 525d77c6a..2beed4064 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 @@ -1,10 +1,14 @@ function New-VSRoute53ResolverResolverEndpoint { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. + Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: .DESCRIPTION - Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. + Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: + ++ An *inbound resolver endpoint* forwards DNS queries to the DNS service for a VPC from your network or another VPC. + ++ An *outbound resolver endpoint* forwards DNS queries from the DNS service for a VPC to your network or another VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html @@ -13,29 +17,41 @@ function New-VSRoute53ResolverResolverEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER IpAddresses + The subnets and IP addresses in your VPC that DNS queries originate from for outbound endpoints or that you forward DNS queries to for inbound endpoints. The subnet ID uniquely identifies a VPC. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-ipaddresses ItemType: IpAddressRequest UpdateType: Mutable .PARAMETER Direction + Indicates whether the resolver endpoint allows inbound or outbound DNS queries: ++ INBOUND: allows DNS queries to your VPC from your network or another VPC ++ OUTBOUND: allows DNS queries from your VPC to your network or another VPC + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-direction PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroupIds + The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules for inbound endpoints or outbound rules for outbound endpoints. Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-securitygroupids UpdateType: Immutable .PARAMETER Tags + A list of the tag keys and values that you want to associate with the endpoint. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 index b8e0dabc5..0e125cd4e 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 @@ -1,10 +1,10 @@ function New-VSRoute53ResolverResolverRule { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverRule resource to the template. + Adds an AWS::Route53Resolver::ResolverRule resource to the template. For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. .DESCRIPTION - Adds an AWS::Route53Resolver::ResolverRule resource to the template. + Adds an AWS::Route53Resolver::ResolverRule resource to the template. For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html @@ -13,33 +13,45 @@ function New-VSRoute53ResolverResolverRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResolverEndpointId + The ID of the endpoint that the rule is associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-resolverendpointid PrimitiveType: String UpdateType: Mutable .PARAMETER DomainName + DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules example.com and www.example.com, the query is routed using the resolver rule that contains the most specific domain name www.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER RuleType + This value is always FORWARD. Other resolver rule types aren't supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-ruletype PrimitiveType: String UpdateType: Immutable .PARAMETER TargetIps + An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-targetips ItemType: TargetAddress UpdateType: Mutable .PARAMETER Tags + A list of the tag keys and values that you want to associate with the endpoint. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name for the resolver rule, which you specified when you created the resolver rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 index da6efa9bc..76b01a610 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSRoute53ResolverResolverRuleAssociation { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. + Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. In the response to an AssociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html, DisassociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html, or ListResolverRuleAssociations: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html request, information about an association between a resolver rule and a VPC. .DESCRIPTION - Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. + Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. In the response to an AssociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html, DisassociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html, or ListResolverRuleAssociations: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html request, information about an association between a resolver rule and a VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html @@ -13,16 +13,22 @@ function New-VSRoute53ResolverResolverRuleAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER VPCId + The ID of the VPC that you associated the resolver rule with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-vpcid PrimitiveType: String UpdateType: Immutable .PARAMETER ResolverRuleId + The ID of the resolver rule that you associated with the VPC that is specified by VPCId. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-resolverruleid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of an association between a resolver rule and a VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 b/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 index edcf5aabb..ae559fe32 100644 --- a/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 @@ -1,10 +1,16 @@ function New-VSS3Bucket { <# .SYNOPSIS - Adds an AWS::S3::Bucket resource to the template. + Adds an AWS::S3::Bucket resource to the template. The AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. .DESCRIPTION - Adds an AWS::S3::Bucket resource to the template. + Adds an AWS::S3::Bucket resource to the template. The AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. + +To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. + +**Important** + +You can only delete empty buckets. Deletion fails for buckets that have contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html @@ -13,16 +19,23 @@ function New-VSS3Bucket { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccelerateConfiguration + Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration Type: AccelerateConfiguration UpdateType: Mutable .PARAMETER AccessControl + A canned access control list ACL that grants predefined permissions to the bucket. For more information about canned ACLs, see Canned ACL: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accesscontrol PrimitiveType: String UpdateType: Mutable .PARAMETER AnalyticsConfigurations + Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. +For more information, see GET Bucket analytics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETAnalyticsConfig.html in the *Amazon Simple Storage Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations DuplicatesAllowed: False ItemType: AnalyticsConfiguration @@ -30,21 +43,30 @@ function New-VSS3Bucket { UpdateType: Mutable .PARAMETER BucketEncryption + Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS-managed keys SSE-KMS bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-bucketencryption Type: BucketEncryption UpdateType: Mutable .PARAMETER BucketName + A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. The bucket name must contain only lowercase letters, numbers, periods ., and dashes -. +If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name PrimitiveType: String UpdateType: Immutable .PARAMETER CorsConfiguration + Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-crossoriginconfig Type: CorsConfiguration UpdateType: Mutable .PARAMETER InventoryConfigurations + Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html in the *Amazon Simple Storage Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations DuplicatesAllowed: False ItemType: InventoryConfiguration @@ -52,16 +74,22 @@ function New-VSS3Bucket { UpdateType: Mutable .PARAMETER LifecycleConfiguration + Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-lifecycleconfig Type: LifecycleConfiguration UpdateType: Mutable .PARAMETER LoggingConfiguration + Settings that define where logs are stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-loggingconfig Type: LoggingConfiguration UpdateType: Mutable .PARAMETER MetricsConfigurations + Specifies a metrics configuration for the CloudWatch request metrics specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html in the *Amazon Simple Storage Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-metricsconfigurations DuplicatesAllowed: False ItemType: MetricsConfiguration @@ -69,31 +97,45 @@ function New-VSS3Bucket { UpdateType: Mutable .PARAMETER NotificationConfiguration + Configuration that defines how Amazon S3 handles bucket notifications. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-notification Type: NotificationConfiguration UpdateType: Mutable .PARAMETER ObjectLockConfiguration + Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration Type: ObjectLockConfiguration UpdateType: Mutable .PARAMETER ObjectLockEnabled + Indicates whether this bucket has an object lock configuration enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockenabled PrimitiveType: Boolean UpdateType: Immutable .PARAMETER PublicAccessBlockConfiguration + Configuration that defines how Amazon S3 handles public access. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-publicaccessblockconfiguration Type: PublicAccessBlockConfiguration UpdateType: Mutable .PARAMETER ReplicationConfiguration + Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property. +Amazon S3 can store replicated objects in only one destination bucket. The destination bucket must already exist and be in a different AWS Region than your source bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-replicationconfiguration Type: ReplicationConfiguration UpdateType: Mutable .PARAMETER Tags + An arbitrary set of tags key-value pairs for this S3 bucket. +We recommend limiting the number of tags to seven. Applying more than seven tags prevents the AWS CLI and the AWS CloudFormation console and API actions from listing the tags for the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-tags DuplicatesAllowed: True ItemType: Tag @@ -101,11 +143,15 @@ function New-VSS3Bucket { UpdateType: Mutable .PARAMETER VersioningConfiguration + Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-versioning Type: VersioningConfiguration UpdateType: Mutable .PARAMETER WebsiteConfiguration + Information used to configure the bucket as a static website. For more information, see Hosting Websites on Amazon S3: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-websiteconfiguration Type: WebsiteConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 index 158d84133..4403f3948 100644 --- a/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 @@ -1,10 +1,10 @@ function New-VSS3BucketPolicy { <# .SYNOPSIS - Adds an AWS::S3::BucketPolicy resource to the template. + Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. .DESCRIPTION - Adds an AWS::S3::BucketPolicy resource to the template. + Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html @@ -13,11 +13,15 @@ function New-VSS3BucketPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Bucket + The name of the Amazon S3 bucket to which the policy applies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-bucket PrimitiveType: String UpdateType: Immutable .PARAMETER PolicyDocument + A policy document containing permissions to add to the specified bucket. For more information, see Access Policy Language Overview: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-policydocument PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 b/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 index ca79c6d41..e025e10c5 100644 --- a/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 @@ -1,10 +1,14 @@ function New-VSSDBDomain { <# .SYNOPSIS - Adds an AWS::SDB::Domain resource to the template. + Adds an AWS::SDB::Domain resource to the template. Use the AWS::SDB::Domain resource to declare a SimpleDB domain. When you specify AWS::SDB::Domain as an argument in a Ref function, AWS CloudFormation returns the value of the DomainName. .DESCRIPTION - Adds an AWS::SDB::Domain resource to the template. + Adds an AWS::SDB::Domain resource to the template. Use the AWS::SDB::Domain resource to declare a SimpleDB domain. When you specify AWS::SDB::Domain as an argument in a Ref function, AWS CloudFormation returns the value of the DomainName. + +**Important** + +The AWS::SDB::Domain resource does not allow any updates, including metadata updates. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simpledb.html @@ -13,6 +17,8 @@ function New-VSSDBDomain { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Information about the SimpleDB domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simpledb.html#cfn-sdb-domain-description PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 b/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 index 9fe76dd11..fa5273634 100644 --- a/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 @@ -1,10 +1,10 @@ function New-VSSESConfigurationSet { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSet resource to the template. + Adds an AWS::SES::ConfigurationSet resource to the template. Specifies a configuration set. Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html in the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/. .DESCRIPTION - Adds an AWS::SES::ConfigurationSet resource to the template. + Adds an AWS::SES::ConfigurationSet resource to the template. Specifies a configuration set. Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html in the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html @@ -13,6 +13,10 @@ function New-VSSESConfigurationSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name of the configuration set. The name must: ++ Only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ Contain 64 characters or fewer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-name UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 b/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 index 3d1040d13..76914821b 100644 --- a/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 @@ -1,10 +1,18 @@ function New-VSSESConfigurationSetEventDestination { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. + Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. Specifies a configuration set event destination. .DESCRIPTION - Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. + Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. Specifies a configuration set event destination. + +**Note** + +When you specify an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Data Firehose, or Amazon Simple Notification Service (Amazon SNS. + +An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. + +You can execute this operation no more than once per second. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html @@ -13,11 +21,15 @@ function New-VSSESConfigurationSetEventDestination { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConfigurationSetName + The name of the configuration set that contains the event destination that you want to update. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-configurationsetname PrimitiveType: String UpdateType: Immutable .PARAMETER EventDestination + The event destination object that you want to apply to the specified configuration set. + Type: EventDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-eventdestination UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 b/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 index 990ed6045..aa81ff963 100644 --- a/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 @@ -1,10 +1,10 @@ function New-VSSESReceiptFilter { <# .SYNOPSIS - Adds an AWS::SES::ReceiptFilter resource to the template. + Adds an AWS::SES::ReceiptFilter resource to the template. Specify a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html. .DESCRIPTION - Adds an AWS::SES::ReceiptFilter resource to the template. + Adds an AWS::SES::ReceiptFilter resource to the template. Specify a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptfilter.html @@ -13,6 +13,8 @@ function New-VSSESReceiptFilter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Filter + A data structure that describes the IP address filter that you want to specify. This object consists of a name, an IP address range, and a boolean that indicates whether to allow or block mail from the IP range. + Type: Filter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptfilter.html#cfn-ses-receiptfilter-filter UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 b/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 index 5f1e57ec9..67182ab5b 100644 --- a/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 @@ -1,10 +1,14 @@ function New-VSSESReceiptRule { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRule resource to the template. + Adds an AWS::SES::ReceiptRule resource to the template. Specifies a receipt rule. .DESCRIPTION - Adds an AWS::SES::ReceiptRule resource to the template. + Adds an AWS::SES::ReceiptRule resource to the template. Specifies a receipt rule. + +For information about setting up receipt rules, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html. + +You can execute this operation no more than once per second. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html @@ -13,16 +17,22 @@ function New-VSSESReceiptRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER After + The name of the existing rule that you want to place the current rule after. If this parameter is null, the new rule is added as the first entry in the receipt rule set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after PrimitiveType: String UpdateType: Mutable .PARAMETER Rule + A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy. + Type: Rule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rule UpdateType: Mutable .PARAMETER RuleSetName + The name of the rule set that you want to add the receipt rule to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rulesetname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 b/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 index 04c3eed82..d3fb0fb5d 100644 --- a/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 @@ -1,10 +1,14 @@ function New-VSSESReceiptRuleSet { <# .SYNOPSIS - Adds an AWS::SES::ReceiptRuleSet resource to the template. + Adds an AWS::SES::ReceiptRuleSet resource to the template. Specifies an empty receipt rule set. .DESCRIPTION - Adds an AWS::SES::ReceiptRuleSet resource to the template. + Adds an AWS::SES::ReceiptRuleSet resource to the template. Specifies an empty receipt rule set. + +For information about setting up receipt rule sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html. + +You can execute this operation no more than once per second. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html @@ -13,6 +17,8 @@ function New-VSSESReceiptRuleSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RuleSetName + The name of the receipt rule set that you want to reorder. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html#cfn-ses-receiptruleset-rulesetname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 index cef69be44..84a68f727 100644 --- a/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 @@ -1,10 +1,12 @@ function New-VSSESTemplate { <# .SYNOPSIS - Adds an AWS::SES::Template resource to the template. + Adds an AWS::SES::Template resource to the template. Specifies an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html. .DESCRIPTION - Adds an AWS::SES::Template resource to the template. + Adds an AWS::SES::Template resource to the template. Specifies an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html. + +You can execute this operation no more than once per second. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html @@ -13,6 +15,8 @@ function New-VSSESTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Template + The content of the email, composed of a subject line, an HTML part, and a text-only part. + Type: Template Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html#cfn-ses-template-template UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 index 480352650..9323b950f 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 @@ -1,10 +1,10 @@ function New-VSSNSSubscription { <# .SYNOPSIS - Adds an AWS::SNS::Subscription resource to the template. + Adds an AWS::SNS::Subscription resource to the template. The AWS::SNS::Subscription resource subscribes an endpoint to an Amazon Simple Notification Service (Amazon SNS topic. For a subscription to be created, the owner of the endpoint must confirm the subscription. .DESCRIPTION - Adds an AWS::SNS::Subscription resource to the template. + Adds an AWS::SNS::Subscription resource to the template. The AWS::SNS::Subscription resource subscribes an endpoint to an Amazon Simple Notification Service (Amazon SNS topic. For a subscription to be created, the owner of the endpoint must confirm the subscription. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html @@ -13,26 +13,36 @@ function New-VSSNSSubscription { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeliveryPolicy + The JSON serialization of the subscription's delivery policy. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy PrimitiveType: Json UpdateType: Mutable .PARAMETER Endpoint + The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the Subscribe: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html action in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint PrimitiveType: String UpdateType: Immutable .PARAMETER FilterPolicy + The filter policy JSON assigned to the subscription. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy PrimitiveType: Json UpdateType: Mutable .PARAMETER Protocol + The subscription's protocol. For more information, see the Protocol parameter of the Subscribe: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html action in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol PrimitiveType: String UpdateType: Immutable .PARAMETER RawMessageDelivery + When set to true, enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery PrimitiveType: Boolean UpdateType: Mutable @@ -43,11 +53,19 @@ function New-VSSNSSubscription { UpdateType: Mutable .PARAMETER Region + For cross-region subscriptions, the region in which the topic resides. +If no region is specified, CloudFormation uses the region of the caller as the default. +If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either: ++ Updating the Region from NULL to the caller region. ++ Updating the Region from the caller region to NULL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region PrimitiveType: String UpdateType: Mutable .PARAMETER TopicArn + The ARN of the topic to subscribe to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 b/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 index bde1875ec..ff63aa80a 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 @@ -1,10 +1,16 @@ function New-VSSNSTopic { <# .SYNOPSIS - Adds an AWS::SNS::Topic resource to the template. + Adds an AWS::SNS::Topic resource to the template. The AWS::SNS::Topic resource creates a topic to which notifications can be published. .DESCRIPTION - Adds an AWS::SNS::Topic resource to the template. + Adds an AWS::SNS::Topic resource to the template. The AWS::SNS::Topic resource creates a topic to which notifications can be published. + +**Note** + +One user can create a maximum of 100,000 topics. + +This action is idempotent: If the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html @@ -13,16 +19,23 @@ function New-VSSNSTopic { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DisplayName + The display name to use for an Amazon SNS topic with SMS subscriptions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-displayname PrimitiveType: String UpdateType: Mutable .PARAMETER KmsMasterKeyId + The ID of an AWS-managed customer master key CMK for Amazon SNS or a custom CMK. For more information, see Key Terms: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms. For more examples, see KeyId: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters in the *AWS Key Management Service API Reference*. +This property applies only to server-side-encryption: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-kmsmasterkeyid PrimitiveType: String UpdateType: Mutable .PARAMETER Subscription + The SNS subscriptions endpoints for this topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-subscription DuplicatesAllowed: True ItemType: Subscription @@ -30,6 +43,8 @@ function New-VSSNSTopic { UpdateType: Mutable .PARAMETER Tags + + Using an AWS CloudFormation Template to Create a Topic that Sends Messages to Amazon SQS Queues: https://docs.aws.amazon.com/sns/latest/dg/SendMessageToSQS.cloudformation.html in the *Amazon Simple Notification Service Developer Guide* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-tags DuplicatesAllowed: True ItemType: Tag @@ -37,6 +52,10 @@ function New-VSSNSTopic { UpdateType: Mutable .PARAMETER TopicName + The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. +If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. +If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-topicname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 index fefdd95c8..cba89e542 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 @@ -1,10 +1,10 @@ function New-VSSNSTopicPolicy { <# .SYNOPSIS - Adds an AWS::SNS::TopicPolicy resource to the template. + Adds an AWS::SNS::TopicPolicy resource to the template. The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy. For an example snippet, see Declaring an Amazon SNS Policy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy in the *AWS CloudFormation User Guide*. .DESCRIPTION - Adds an AWS::SNS::TopicPolicy resource to the template. + Adds an AWS::SNS::TopicPolicy resource to the template. The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy. For an example snippet, see Declaring an Amazon SNS Policy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy in the *AWS CloudFormation User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html @@ -13,11 +13,15 @@ function New-VSSNSTopicPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PolicyDocument + A policy document that contains permissions to add to the specified SNS topics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER Topics + The Amazon Resource Names ARN of the topics to which you want to add the policy. You can use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function to specify an AWS::SNS::Topic: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 b/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 index c5178cd68..7e9315f43 100644 --- a/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 @@ -1,10 +1,26 @@ function New-VSSQSQueue { <# .SYNOPSIS - Adds an AWS::SQS::Queue resource to the template. + Adds an AWS::SQS::Queue resource to the template. The AWS::SQS::Queue resource creates an Amazon Simple Queue Service (Amazon SQS standard or FIFO queue. .DESCRIPTION - Adds an AWS::SQS::Queue resource to the template. + Adds an AWS::SQS::Queue resource to the template. The AWS::SQS::Queue resource creates an Amazon Simple Queue Service (Amazon SQS standard or FIFO queue. + +Keep the following caveats in mind: + ++ If you don't specify the FifoQueue property, Amazon SQS creates a standard queue. + +**Note** + +You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving in the *Amazon Simple Queue Service Developer Guide*. + ++ If you don't provide a value for a property, the queue is created with the default value for the property. + ++ If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. + ++ To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html and is unique within the scope of your queues. + +For more information about creating FIFO (first-in-first-out queues, see the tutorial Create a Queue Using AWS CloudFormation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-create-queue.html#create-queue-cloudformation in the *Amazon Simple Queue Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html @@ -13,56 +29,92 @@ function New-VSSQSQueue { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ContentBasedDeduplication + For first-in-first-out FIFO queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html action in the *Amazon Simple Queue Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-contentbaseddeduplication PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DelaySeconds + The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 15 minutes. The default value is 0. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-delayseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER FifoQueue + If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue. For more information, see FIFO First-In-First-Out Queues: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html in the *Amazon Simple Queue Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-fifoqueue PrimitiveType: Boolean UpdateType: Immutable .PARAMETER KmsDataKeyReusePeriodSeconds + The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 1 minute and 86,400 24 hours. The default is 300 5 minutes. +A shorter time period provides better security, but results in more calls to AWS KMS, which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work in the *Amazon Simple Queue Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsdatakeyreuseperiodseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER KmsMasterKeyId + The ID of an AWS managed customer master key CMK for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the alias alias/aws/sqs. For more information, see the following: ++ Protecting Data Using Server-Side Encryption SSE and AWS KMS: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html in the *Amazon Simple Queue Service Developer Guide* ++ CreateQueue: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html in the *Amazon Simple Queue Service API Reference* ++ The Customer Master Keys section of the AWS Key Management Service Best Practices: https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf whitepaper + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsmasterkeyid PrimitiveType: String UpdateType: Mutable .PARAMETER MaximumMessageSize + The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes 1 KiB to 262,144 bytes 256 KiB. The default value is 262,144 256 KiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-maxmesgsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER MessageRetentionPeriod + The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds 1 minute to 1,209,600 seconds 14 days. The default value is 345,600 seconds 4 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-msgretentionperiod PrimitiveType: Integer UpdateType: Mutable .PARAMETER QueueName + A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO First-In-First-Out Queues: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html in the *Amazon Simple Queue Service Developer Guide*. +If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html in the *AWS CloudFormation User Guide*. +If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-name PrimitiveType: String UpdateType: Immutable .PARAMETER ReceiveMessageWaitTimeSeconds + Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Amazon SQS Long Poll: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-receivemsgwaittime PrimitiveType: Integer UpdateType: Mutable .PARAMETER RedrivePolicy + A string that includes the parameters for the dead-letter queue functionality redrive policy of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html in the *Amazon Simple Queue Service Developer Guide*. +The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. +*JSON* +{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } +*YAML* +deadLetterTargetArn : String +maxReceiveCount : Integer ++ deadLetterTargetArn – The Amazon Resource Name ARN of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. ++ maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-redrive PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + The tags that you attach to this queue. For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html in the *AWS CloudFormation User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#cfn-sqs-queue-tags DuplicatesAllowed: True ItemType: Tag @@ -70,6 +122,10 @@ function New-VSSQSQueue { UpdateType: Mutable .PARAMETER VisibilityTimeout + The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. +Values must be from 0 to 43,200 seconds 12 hours. If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. +For more information about Amazon SQS queue visibility timeouts, see Visibility Timeout: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html in the *Amazon Simple Queue Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-visiblitytimeout PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 index f57755a34..f1b06ecad 100644 --- a/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 @@ -1,10 +1,10 @@ function New-VSSQSQueuePolicy { <# .SYNOPSIS - Adds an AWS::SQS::QueuePolicy resource to the template. + Adds an AWS::SQS::QueuePolicy resource to the template. The AWS::SQS::QueuePolicy type applies a policy to Amazon SQS queues. For an example snippet, see Declaring an Amazon SQS Policy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy in the *AWS CloudFormation User Guide*. .DESCRIPTION - Adds an AWS::SQS::QueuePolicy resource to the template. + Adds an AWS::SQS::QueuePolicy resource to the template. The AWS::SQS::QueuePolicy type applies a policy to Amazon SQS queues. For an example snippet, see Declaring an Amazon SQS Policy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy in the *AWS CloudFormation User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html @@ -13,11 +13,15 @@ function New-VSSQSQueuePolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PolicyDocument + A policy document that contains the permissions for the specified Amazon SQS queues. For more information about Amazon SQS policies, see Creating Custom Policies Using the Access Policy Language: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html in the *Amazon Simple Queue Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc PrimitiveType: Json UpdateType: Mutable .PARAMETER Queues + The URLs of the queues to which you want to add the policy. You can use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function to specify an AWS::SQS::Queue: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues DuplicatesAllowed: True PrimitiveItemType: String diff --git a/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 index b8aa7d34f..30b846480 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSSSMAssociation { <# .SYNOPSIS - Adds an AWS::SSM::Association resource to the template. + Adds an AWS::SSM::Association resource to the template. The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with managed instances that contain a configuration agent to process the document. .DESCRIPTION - Adds an AWS::SSM::Association resource to the template. + Adds an AWS::SSM::Association resource to the template. The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with managed instances that contain a configuration agent to process the document. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html @@ -13,31 +13,44 @@ function New-VSSSMAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssociationName + The name of the association. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname PrimitiveType: String UpdateType: Mutable .PARAMETER DocumentVersion + The version of the SSM document to associate with the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceId + The ID of the instance that the SSM document is associated with. +You must specify the InstanceId or Targets property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the Systems Manager document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name PrimitiveType: String UpdateType: Immutable .PARAMETER OutputLocation + An Amazon S3 bucket where you want to store the output details of the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation Type: InstanceAssociationOutputLocation UpdateType: Mutable .PARAMETER Parameters + The parameters for the runtime configuration of the document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters DuplicatesAllowed: False ItemType: ParameterValues @@ -45,11 +58,16 @@ function New-VSSSMAssociation { UpdateType: Mutable .PARAMETER ScheduleExpression + A cron expression that specifies a schedule when the association runs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression PrimitiveType: String UpdateType: Mutable .PARAMETER Targets + The targets that the SSM document sends commands to. +You must specify the InstanceId or Targets property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets DuplicatesAllowed: False ItemType: Target diff --git a/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 b/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 index adf31d34d..1317ee8de 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 @@ -1,10 +1,10 @@ function New-VSSSMDocument { <# .SYNOPSIS - Adds an AWS::SSM::Document resource to the template. + Adds an AWS::SSM::Document resource to the template. The AWS::SSM::Document resource creates an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which you can use to set up and run commands on your instances. .DESCRIPTION - Adds an AWS::SSM::Document resource to the template. + Adds an AWS::SSM::Document resource to the template. The AWS::SSM::Document resource creates an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which you can use to set up and run commands on your instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html @@ -13,21 +13,29 @@ function New-VSSSMDocument { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Content + A valid JSON or YAML string. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content PrimitiveType: Json UpdateType: Immutable .PARAMETER DocumentType + The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype PrimitiveType: String UpdateType: Immutable .PARAMETER Name + + AWS Systems Manager Documents: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags DuplicatesAllowed: True ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 index b9e269942..c7ab4f2c3 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 @@ -1,10 +1,12 @@ function New-VSSSMMaintenanceWindow { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindow resource to the template. + Adds an AWS::SSM::MaintenanceWindow resource to the template. The AWS::SSM::MaintenanceWindow resource represents general information about a maintenance window for AWS Systems Manager. Maintenance Windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS, updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks. .DESCRIPTION - Adds an AWS::SSM::MaintenanceWindow resource to the template. + Adds an AWS::SSM::MaintenanceWindow resource to the template. The AWS::SSM::MaintenanceWindow resource represents general information about a maintenance window for AWS Systems Manager. Maintenance Windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS, updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks. + +For more information, see Systems Manager Maintenance Windows: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html in the *AWS Systems Manager User Guide* and CreateMaintenanceWindow: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateMaintenanceWindow.html in the *AWS Systems Manager API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html @@ -13,52 +15,72 @@ function New-VSSSMMaintenanceWindow { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER StartDate + The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the maintenance window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description PrimitiveType: String UpdateType: Mutable .PARAMETER AllowUnassociatedTargets + Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances by instance ID when you register a task with the maintenance window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Cutoff + The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff PrimitiveType: Integer UpdateType: Mutable .PARAMETER Schedule + The schedule of the maintenance window in the form of a cron or rate expression. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule PrimitiveType: String UpdateType: Mutable .PARAMETER Duration + The duration of the maintenance window in hours. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration PrimitiveType: Integer UpdateType: Mutable .PARAMETER EndDate + The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + Optional metadata that you assign to a resource in the form of an arbitrary set of tags key-value pairs. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name of the maintenance window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduleTimezone + The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority IANA format. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 index ed2075fb2..7642a90be 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 @@ -1,10 +1,10 @@ function New-VSSSMMaintenanceWindowTarget { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTarget resource to the template. + Adds an AWS::SSM::MaintenanceWindowTarget resource to the template. The AWS::SSM::MaintenanceWindowTarget resource registers a target with a maintenance window for AWS Systems Manager. For more information, see RegisterTargetWithMaintenanceWindow: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html in the *AWS Systems Manager API Reference*. .DESCRIPTION - Adds an AWS::SSM::MaintenanceWindowTarget resource to the template. + Adds an AWS::SSM::MaintenanceWindowTarget resource to the template. The AWS::SSM::MaintenanceWindowTarget resource registers a target with a maintenance window for AWS Systems Manager. For more information, see RegisterTargetWithMaintenanceWindow: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html in the *AWS Systems Manager API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html @@ -13,32 +13,52 @@ function New-VSSSMMaintenanceWindowTarget { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OwnerInformation + A user-provided value that will be included in any CloudWatch events that are raised while running tasks for these targets in this maintenance window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description for the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description PrimitiveType: String UpdateType: Mutable .PARAMETER WindowId + The ID of the maintenance window to register the target with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceType + The type of target that is being registered with the maintenance window. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype PrimitiveType: String UpdateType: Mutable .PARAMETER Targets + The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. +You can specify targets using either instance IDs or tags that have been applied to instances. +**Example 1**: Specify instance IDs +Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 +**Example 2**: Use tag key-pairs applied to instances +Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 +**Example 3**: Use tag-keys applied to instances +Key=tag-key,Values=my-tag-key-1,my-tag-key-2 +For more information about these examples formats, including the best use case for each one, see Examples: Register Targets with a Maintenance Window: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html in the *AWS Systems Manager User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets ItemType: Targets UpdateType: Mutable .PARAMETER Name + The name for the maintenance window target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 index 8b844f851..600110705 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 @@ -1,10 +1,10 @@ function New-VSSSMMaintenanceWindowTask { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask resource to the template. + Adds an AWS::SSM::MaintenanceWindowTask resource to the template. The AWS::SSM::MaintenanceWindowTask resource defines information about a task for an AWS Systems Manager maintenance window. For more information, see RegisterTaskWithMaintenanceWindow: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html in the *AWS Systems Manager API Reference*. .DESCRIPTION - Adds an AWS::SSM::MaintenanceWindowTask resource to the template. + Adds an AWS::SSM::MaintenanceWindowTask resource to the template. The AWS::SSM::MaintenanceWindowTask resource defines information about a task for an AWS Systems Manager maintenance window. For more information, see RegisterTaskWithMaintenanceWindow: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html in the *AWS Systems Manager API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html @@ -13,67 +13,100 @@ function New-VSSSMMaintenanceWindowTask { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MaxErrors + The maximum number of errors allowed before this task stops being scheduled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description PrimitiveType: String UpdateType: Mutable .PARAMETER ServiceRoleArn + The ARN of the IAM service role to use to publish Amazon Simple Notification Service Amazon SNS notifications for maintenance window Run Command tasks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Priority + The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaxConcurrency + The maximum number of targets this task can be run for, in parallel. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency PrimitiveType: String UpdateType: Mutable .PARAMETER Targets + The targets, either instances or window target IDs. ++ Specify instances using Key=InstanceIds,Values=instanceid1,instanceid2 . ++ Specify window target IDs using Key=WindowTargetIds,Values=window-target-id-1,window-target-id-2. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets ItemType: Target UpdateType: Mutable .PARAMETER Name + The task name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name PrimitiveType: String UpdateType: Mutable .PARAMETER TaskArn + The resource that the task uses during execution. +For RUN_COMMAND and AUTOMATION task types, TaskArn is the SSM document name or Amazon Resource Name ARN. +For LAMBDA tasks, TaskArn is the function name or ARN. +For STEP_FUNCTION tasks, TaskArn is the state machine ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn PrimitiveType: String UpdateType: Mutable .PARAMETER TaskInvocationParameters + The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty. + Type: TaskInvocationParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters UpdateType: Mutable .PARAMETER WindowId + The ID of the maintenance window where the task is registered. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid PrimitiveType: String UpdateType: Immutable .PARAMETER TaskParameters + The parameters to pass to the task when it runs. +TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters PrimitiveType: Json UpdateType: Mutable .PARAMETER TaskType + The type of task. Valid values: RUN_COMMAND, AUTOMATION, LAMBDA, STEP_FUNCTION. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype PrimitiveType: String UpdateType: Mutable .PARAMETER LoggingInfo + Information about an Amazon S3 bucket to write task-level logs to. +LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html. + Type: LoggingInfo Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 b/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 index 1d6846d73..3967e53d8 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 @@ -1,10 +1,18 @@ function New-VSSSMParameter { <# .SYNOPSIS - Adds an AWS::SSM::Parameter resource to the template. + Adds an AWS::SSM::Parameter resource to the template. The AWS::SSM::Parameter resource creates an SSM parameter in AWS Systems Manager Parameter Store. .DESCRIPTION - Adds an AWS::SSM::Parameter resource to the template. + Adds an AWS::SSM::Parameter resource to the template. The AWS::SSM::Parameter resource creates an SSM parameter in AWS Systems Manager Parameter Store. + +**Important** + +To create an SSM parameter, you must have the AWS Identity and Access Management (IAM permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, AWS CloudFormation adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify. + +To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see AWS Systems Manager Permissions Reference: https://docs.aws.amazon.com/systems-manager/latest/userguide/auth-and-access-control-permissions-reference.html in the *AWS Systems Manager User Guide*. + +For information about valid values for parameters, see Requirements and Constraints for Parameter Names: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html in the *AWS Systems Manager User Guide* and PutParameter: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html in the *AWS Systems Manager API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html @@ -13,41 +21,60 @@ function New-VSSSMParameter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of parameter. Valid values include the following: String or StringList. +AWS CloudFormation doesn't support the SecureString parameter type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type PrimitiveType: String UpdateType: Mutable .PARAMETER Description + Information about the parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description PrimitiveType: String UpdateType: Mutable .PARAMETER Policies + Information about the policies assigned to a parameter. +Working with Parameter Policies: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html in the *AWS Systems Manager User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies PrimitiveType: String UpdateType: Mutable .PARAMETER AllowedPattern + A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^d+$ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern PrimitiveType: String UpdateType: Mutable .PARAMETER Tier + The parameter tier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The parameter value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 b/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 index eb049ae57..b4f059a84 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 @@ -1,10 +1,12 @@ function New-VSSSMPatchBaseline { <# .SYNOPSIS - Adds an AWS::SSM::PatchBaseline resource to the template. + Adds an AWS::SSM::PatchBaseline resource to the template. The AWS::SSM::PatchBaseline resource defines the basic information for an AWS Systems Manager patch baseline. A patch baseline defines which patches are approved for installation on your instances. .DESCRIPTION - Adds an AWS::SSM::PatchBaseline resource to the template. + Adds an AWS::SSM::PatchBaseline resource to the template. The AWS::SSM::PatchBaseline resource defines the basic information for an AWS Systems Manager patch baseline. A patch baseline defines which patches are approved for installation on your instances. + +For more information, see CreatePatchBaseline: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html in the *AWS Systems Manager API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html @@ -13,70 +15,100 @@ function New-VSSSMPatchBaseline { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OperatingSystem + Defines the operating system the patch baseline applies to. The Default value is WINDOWS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A description of the patch baseline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description PrimitiveType: String UpdateType: Mutable .PARAMETER ApprovalRules + A set of rules used to include patches in the baseline. + Type: RuleGroup Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules UpdateType: Mutable .PARAMETER Sources + Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources ItemType: PatchSource UpdateType: Mutable .PARAMETER Name + The name of the patch baseline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name PrimitiveType: String UpdateType: Mutable .PARAMETER RejectedPatches + A list of explicitly rejected patches for the baseline. +For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html in the *AWS Systems Manager User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches UpdateType: Mutable .PARAMETER ApprovedPatches + A list of explicitly approved patches for the baseline. +For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html in the *AWS Systems Manager User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches UpdateType: Mutable .PARAMETER RejectedPatchesAction + The action for Patch Manager to take on patches included in the RejectedPackages list. ++ **ALLOW_AS_DEPENDENCY**: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as *InstalledOther*. This is the default action if no option is specified. ++ **BLOCK**: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as *InstalledRejected*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction PrimitiveType: String UpdateType: Mutable .PARAMETER PatchGroups + The name of the patch group that should be registered with the patch baseline. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups UpdateType: Mutable .PARAMETER ApprovedPatchesComplianceLevel + Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel PrimitiveType: String UpdateType: Mutable .PARAMETER ApprovedPatchesEnableNonSecurity + Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity PrimitiveType: Boolean UpdateType: Mutable .PARAMETER GlobalFilters + A set of global filters used to include patches in the baseline. + Type: PatchFilterGroup Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters UpdateType: Mutable .PARAMETER Tags + Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 b/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 index 63dc66a96..27087e921 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 @@ -1,10 +1,12 @@ function New-VSSSMResourceDataSync { <# .SYNOPSIS - Adds an AWS::SSM::ResourceDataSync resource to the template. + Adds an AWS::SSM::ResourceDataSync resource to the template. The AWS::SSM::ResourceDataSync resource creates or deletes a Resource Data Sync for AWS Systems Manager Inventory. You can use Resource Data Sync to send Inventory data collected from all of your Systems Manager managed instances to a single Amazon S3 bucket that you have already created in your account. Resource Data Sync then automatically updates the centralized data when new Inventory data is collected. .DESCRIPTION - Adds an AWS::SSM::ResourceDataSync resource to the template. + Adds an AWS::SSM::ResourceDataSync resource to the template. The AWS::SSM::ResourceDataSync resource creates or deletes a Resource Data Sync for AWS Systems Manager Inventory. You can use Resource Data Sync to send Inventory data collected from all of your Systems Manager managed instances to a single Amazon S3 bucket that you have already created in your account. Resource Data Sync then automatically updates the centralized data when new Inventory data is collected. + +For more information, see Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync in the *AWS Systems Manager User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html @@ -13,46 +15,64 @@ function New-VSSSMResourceDataSync { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER S3Destination + + Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html + Type: S3Destination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination UpdateType: Immutable .PARAMETER KMSKeyArn + The ARN of an encryption key for a destination in Amazon S3. You can use a KMS key to encrypt inventory data in Amazon S3. You must specify a key that exist in the same region as the destination Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn PrimitiveType: String UpdateType: Immutable .PARAMETER SyncSource + + Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html + Type: SyncSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource UpdateType: Mutable .PARAMETER BucketName + The name of the Amazon S3 bucket where the aggregated data is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname PrimitiveType: String UpdateType: Immutable .PARAMETER BucketRegion + The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion PrimitiveType: String UpdateType: Immutable .PARAMETER SyncFormat + A supported sync format. The following format is currently supported: JsonSerDe + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat PrimitiveType: String UpdateType: Immutable .PARAMETER SyncName + A name for the Resource Data Sync. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname PrimitiveType: String UpdateType: Immutable .PARAMETER SyncType + + Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype PrimitiveType: String UpdateType: Immutable .PARAMETER BucketPrefix + An Amazon S3 prefix for the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 index 4930a6a31..37a525ae1 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 @@ -1,10 +1,12 @@ function New-VSSageMakerCodeRepository { <# .SYNOPSIS - Adds an AWS::SageMaker::CodeRepository resource to the template. + Adds an AWS::SageMaker::CodeRepository resource to the template. Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. .DESCRIPTION - Adds an AWS::SageMaker::CodeRepository resource to the template. + Adds an AWS::SageMaker::CodeRepository resource to the template. Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. + +The repository can be hosted either in AWS CodeCommit: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html or in any other Git repository. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html @@ -13,11 +15,15 @@ function New-VSSageMakerCodeRepository { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CodeRepositoryName + The name of the Git repository. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-coderepositoryname PrimitiveType: String UpdateType: Immutable .PARAMETER GitConfig + Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository. + Type: GitConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-gitconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 index 9da4af33a..fbaadcd8e 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 @@ -1,10 +1,10 @@ function New-VSSageMakerEndpoint { <# .SYNOPSIS - Adds an AWS::SageMaker::Endpoint resource to the template. + Adds an AWS::SageMaker::Endpoint resource to the template. Use the AWS::SageMaker::Endpoint resource to create an endpoint using the specified configuration in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the AWS::SageMaker::EndpointConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html resource. For more information, see Deploy a Model on Amazon SageMaker Hosting Services: https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html in the *Amazon SageMaker Developer Guide*. .DESCRIPTION - Adds an AWS::SageMaker::Endpoint resource to the template. + Adds an AWS::SageMaker::Endpoint resource to the template. Use the AWS::SageMaker::Endpoint resource to create an endpoint using the specified configuration in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the AWS::SageMaker::EndpointConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html resource. For more information, see Deploy a Model on Amazon SageMaker Hosting Services: https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html in the *Amazon SageMaker Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html @@ -18,6 +18,8 @@ function New-VSSageMakerEndpoint { UpdateType: Mutable .PARAMETER EndpointName + The name of the endpoint. The name must be unique within an AWS Region in your AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointname PrimitiveType: String UpdateType: Immutable @@ -29,11 +31,16 @@ function New-VSSageMakerEndpoint { UpdateType: Mutable .PARAMETER EndpointConfigName + The name of the AWS::SageMaker::EndpointConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointconfigname PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A list of key-value pairs to apply to this resource. +For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html and Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what in the * AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 index a474883d6..41262463c 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 @@ -1,10 +1,10 @@ function New-VSSageMakerEndpointConfig { <# .SYNOPSIS - Adds an AWS::SageMaker::EndpointConfig resource to the template. + Adds an AWS::SageMaker::EndpointConfig resource to the template. The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig: https://docs-aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html in the *SageMaker Developer Guide*. .DESCRIPTION - Adds an AWS::SageMaker::EndpointConfig resource to the template. + Adds an AWS::SageMaker::EndpointConfig resource to the template. The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig: https://docs-aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html in the *SageMaker Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html @@ -13,22 +13,31 @@ function New-VSSageMakerEndpointConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ProductionVariants + A list of ProductionVariant objects, one for each model that you want to host at this endpoint. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-productionvariants ItemType: ProductionVariant UpdateType: Immutable .PARAMETER KmsKeyId + The Amazon Resource Name ARN of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER EndpointConfigName + The name of the endpoint configuration. You specify this name in a CreateEndpoint: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-endpointconfigname PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + A list of key-value pairs to apply to this resource. +For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html and Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 index 36a87df72..427f78d93 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 @@ -1,10 +1,10 @@ function New-VSSageMakerModel { <# .SYNOPSIS - Adds an AWS::SageMaker::Model resource to the template. + Adds an AWS::SageMaker::Model resource to the template. The AWS::SageMaker::Model resource to create a model to host at an Amazon SageMaker endpoint. For more information, see Deploying a Model on Amazon SageMaker Hosting Services: https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html in the *Amazon SageMaker Developer Guide*. .DESCRIPTION - Adds an AWS::SageMaker::Model resource to the template. + Adds an AWS::SageMaker::Model resource to the template. The AWS::SageMaker::Model resource to create a model to host at an Amazon SageMaker endpoint. For more information, see Deploying a Model on Amazon SageMaker Hosting Services: https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html in the *Amazon SageMaker Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html @@ -13,32 +13,46 @@ function New-VSSageMakerModel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ExecutionRoleArn + The Amazon Resource Name ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html. +To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-executionrolearn PrimitiveType: String UpdateType: Immutable .PARAMETER PrimaryContainer + The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. + Type: ContainerDefinition Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-primarycontainer UpdateType: Immutable .PARAMETER ModelName + The name of the new model. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-modelname PrimitiveType: String UpdateType: Immutable .PARAMETER VpcConfig + A VpcConfig: https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html. + Type: VpcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-vpcconfig UpdateType: Immutable .PARAMETER Containers + Specifies the containers in the inference pipeline. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-containers ItemType: ContainerDefinition UpdateType: Immutable .PARAMETER Tags + A list of key-value pairs to apply to this resource. +For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html and Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what in the *AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 index 1d06be99b..6002531df 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 @@ -1,10 +1,10 @@ function New-VSSageMakerNotebookInstance { <# .SYNOPSIS - Adds an AWS::SageMaker::NotebookInstance resource to the template. + Adds an AWS::SageMaker::NotebookInstance resource to the template. The AWS::SageMaker::NotebookInstance resource creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html. .DESCRIPTION - Adds an AWS::SageMaker::NotebookInstance resource to the template. + Adds an AWS::SageMaker::NotebookInstance resource to the template. The AWS::SageMaker::NotebookInstance resource creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html @@ -13,74 +13,107 @@ function New-VSSageMakerNotebookInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KmsKeyId + The Amazon Resource Name ARN of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys: https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html in the *AWS Key Management Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER VolumeSizeInGB + The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb PrimitiveType: Integer UpdateType: Mutable .PARAMETER AdditionalCodeRepositories + An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories UpdateType: Mutable .PARAMETER DefaultCodeRepository + The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository PrimitiveType: String UpdateType: Mutable .PARAMETER DirectInternetAccess + Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC. +For more information, see Notebook Instances Are Internet-Enabled by Default: https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess PrimitiveType: String UpdateType: Immutable .PARAMETER AcceleratorTypes + A list of Elastic Inference EI instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes UpdateType: Mutable .PARAMETER SubnetId + The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroupIds + The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids UpdateType: Immutable .PARAMETER RoleArn + When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal sagemaker.amazonaws.com permissions to assume this role. For more information, see Amazon SageMaker Roles: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html. +To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER RootAccess + Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. +Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess PrimitiveType: String UpdateType: Mutable .PARAMETER NotebookInstanceName + The name of the new notebook instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceType + The type of ML compute instance to launch for the notebook instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype PrimitiveType: String UpdateType: Mutable .PARAMETER LifecycleConfigName + The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Customize a Notebook Instance: https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html in the *Amazon SageMaker Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A list of key-value pairs to apply to this resource. +For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html and Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what. +You can add tags later by using the CreateTags API. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 index 43ef21a07..ad58124db 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 @@ -1,10 +1,10 @@ function New-VSSageMakerNotebookInstanceLifecycleConfig { <# .SYNOPSIS - Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig resource to the template. + Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig resource to the template. The AWS::SageMaker::NotebookInstanceLifecycleConfig resource creates shell scripts that run when you create and/or start a notebook instance. For information about notebook instance lifestyle configurations, see Customize a Notebook Instance: https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html in the *Amazon SageMaker Developer Guide*. .DESCRIPTION - Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig resource to the template. + Adds an AWS::SageMaker::NotebookInstanceLifecycleConfig resource to the template. The AWS::SageMaker::NotebookInstanceLifecycleConfig resource creates shell scripts that run when you create and/or start a notebook instance. For information about notebook instance lifestyle configurations, see Customize a Notebook Instance: https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html in the *Amazon SageMaker Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html @@ -13,17 +13,23 @@ function New-VSSageMakerNotebookInstanceLifecycleConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OnStart + A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html#cfn-sagemaker-notebookinstancelifecycleconfig-onstart ItemType: NotebookInstanceLifecycleHook UpdateType: Mutable .PARAMETER NotebookInstanceLifecycleConfigName + The name of the lifecycle configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html#cfn-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecycleconfigname PrimitiveType: String UpdateType: Immutable .PARAMETER OnCreate + A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html#cfn-sagemaker-notebookinstancelifecycleconfig-oncreate ItemType: NotebookInstanceLifecycleHook diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 index e67f3b245..fb3d49581 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 @@ -1,10 +1,12 @@ function New-VSSageMakerWorkteam { <# .SYNOPSIS - Adds an AWS::SageMaker::Workteam resource to the template. + Adds an AWS::SageMaker::Workteam resource to the template. Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. .DESCRIPTION - Adds an AWS::SageMaker::Workteam resource to the template. + Adds an AWS::SageMaker::Workteam resource to the template. Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. + +You cannot create more than 25 work teams in an account and region. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html @@ -13,27 +15,38 @@ function New-VSSageMakerWorkteam { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the work team. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-description PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationConfiguration + Configures SNS notifications of available or expiring work items for work teams. + Type: NotificationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-notificationconfiguration UpdateType: Mutable .PARAMETER WorkteamName + The name of the work team. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-workteamname PrimitiveType: String UpdateType: Immutable .PARAMETER MemberDefinitions + The Amazon Cognito user groups that make up the work team. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-memberdefinitions ItemType: MemberDefinition UpdateType: Mutable .PARAMETER Tags + A list of key-value pairs to apply to this resource. +For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html and Using Cost Allocation Tags: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what in the * AWS Billing and Cost Management User Guide*. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 index 6c4b7e619..17e612bbe 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 @@ -1,10 +1,10 @@ function New-VSSecretsManagerResourcePolicy { <# .SYNOPSIS - Adds an AWS::SecretsManager::ResourcePolicy resource to the template. + Adds an AWS::SecretsManager::ResourcePolicy resource to the template. Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all relevant policies. .DESCRIPTION - Adds an AWS::SecretsManager::ResourcePolicy resource to the template. + Adds an AWS::SecretsManager::ResourcePolicy resource to the template. Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all relevant policies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html @@ -13,11 +13,16 @@ function New-VSSecretsManagerResourcePolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretId + Specifies the Amazon Resource Name ARN or the friendly name of the secret that you want to attach a resource-based permissions policy to. +If you use this property to change the SecretId for an existing resource-based policy, it removes the policy from the original secret, and then attaches the policy to the secret with the specified SecretId. This results in changing the permissions for two secrets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-secretid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourcePolicy + Specifies a JSON object that's constructed according to the grammar and syntax for a resource-based policy. The policy identifies who can access or manage this secret and its versions. For information on how to format a JSON object as a parameter for this resource type, see Using Resource-based Policies for Secrets Manager: https://docs.aws.amazon.com/secretsmanager/latest/UserGuide/auth-and-access-resource-based-policies.htmlin the AWS Secrets Manager User Guide. Those same rules apply here. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-resourcepolicy PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 index 7570e4ec9..14adb7c46 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 @@ -1,10 +1,14 @@ function New-VSSecretsManagerRotationSchedule { <# .SYNOPSIS - Adds an AWS::SecretsManager::RotationSchedule resource to the template. + Adds an AWS::SecretsManager::RotationSchedule resource to the template. The AWS::SecretsManager::RotationSchedule resource configures rotation for a secret. The secret must already be configured with the details of the database or service. If you define both the secret and the database or service in an AWS CloudFormation template, then define the AWS::SecretsManager::SecretTargetAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html resource to populate the secret with the connection details of the database or service before you attempt to configure rotation. .DESCRIPTION - Adds an AWS::SecretsManager::RotationSchedule resource to the template. + Adds an AWS::SecretsManager::RotationSchedule resource to the template. The AWS::SecretsManager::RotationSchedule resource configures rotation for a secret. The secret must already be configured with the details of the database or service. If you define both the secret and the database or service in an AWS CloudFormation template, then define the AWS::SecretsManager::SecretTargetAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html resource to populate the secret with the connection details of the database or service before you attempt to configure rotation. + +**Important** + +When you configure rotation for a secret, AWS CloudFormation automatically rotates the secret one time. Ensure that you configure all your clients to retrieve the secret using Secrets Manager before configuring rotation to prevent breaking them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html @@ -13,16 +17,22 @@ function New-VSSecretsManagerRotationSchedule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretId + Specifies the Amazon Resource Name ARN or the friendly name of the secret that you want to rotate. To reference a secret also that's created in this template, use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the secret's logical ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-secretid PrimitiveType: String UpdateType: Immutable .PARAMETER RotationLambdaARN + Specifies the ARN of the Lambda function that can rotate the secret. If you don't specify this parameter, then the secret must already have the ARN of a Lambda function configured. To reference a Lambda function that's also created in this template, use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the function's logical ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationlambdaarn PrimitiveType: String UpdateType: Mutable .PARAMETER RotationRules + Specifies a structure that defines the rotation schedule for this secret. + Type: RotationRules Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationrules UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 index e716f1a1c..5c1fd2bab 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 @@ -1,10 +1,28 @@ function New-VSSecretsManagerSecret { <# .SYNOPSIS - Adds an AWS::SecretsManager::Secret resource to the template. + Adds an AWS::SecretsManager::Secret resource to the template. The AWS::SecretsManager::Secret resource creates a secret and stores it in Secrets Manager. For more information, see Secret: https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_secret in the *AWS Secrets Manager User Guide*, and the CreateSecret API: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html in the *AWS Secrets Manager API Reference*. .DESCRIPTION - Adds an AWS::SecretsManager::Secret resource to the template. + Adds an AWS::SecretsManager::Secret resource to the template. The AWS::SecretsManager::Secret resource creates a secret and stores it in Secrets Manager. For more information, see Secret: https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_secret in the *AWS Secrets Manager User Guide*, and the CreateSecret API: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html in the *AWS Secrets Manager API Reference*. + +To specify the SecretString encrypted value for the secret, specify either the SecretString or the GenerateSecretString property in this resource. You must specify one or the other, but you can't specify both. See the first two examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-hardcoded later in this topic. + +**Note** + +You can't generate a secret with a SecretBinary secret value using AWS CloudFormation. You can create only a SecretString text-based secret value. + +**Note** + +Do not create a dynamic reference that has a backslash (as the final value. AWS CloudFormation cannot resolve those references, which results in a resource failure. + +After you create the basic secret, you can do any of the following: + ++ Configure your secret with details of the Secrets Manager supported database or service: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html#full-rotation-support whose credentials are stored in this secret. + ++ Attach a resource-based permissions policy to the secret. To do this, define a AWS::SecretsManager::ResourcePolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html resource type. + ++ You can optionally configure a secret to rotate after a specified number of days. See AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html @@ -13,32 +31,49 @@ function New-VSSecretsManagerSecret { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + Specifies a user-provided description of the secret. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-description PrimitiveType: String UpdateType: Mutable .PARAMETER KmsKeyId + Specifies the ARN, Key ID, or alias of the AWS KMS customer master key CMK that's used to encrypt the SecretString or SecretBinary values for versions of this secret. If you don't specify this value, then Secrets Manager defaults to the AWS account's CMK the one named aws/secretsmanager. If an AWS KMS CMK with that name doesn't yet exist, Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields. +You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-kmskeyid PrimitiveType: String UpdateType: Mutable .PARAMETER SecretString + Specifies a literal string to use as the secret value for the secret. You can use any text you like, but remember that Lambda rotation functions require a specific JSON structure to be present in this field. +Alternatively, instead of hardcoding the password in this string parameter, we recommend that you use the GenerateSecretString parameter instead. +You must specify either SecretString or GenerateSecretString, but not both. +Stack updates that modify a SecretString property, will immediately change the secret's value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-secretstring PrimitiveType: String UpdateType: Mutable .PARAMETER GenerateSecretString + A structure that specifies how to generate a random password by using the functionality of the GetRandomPassword API: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetRandomPassword.html. You can return that string directly to use as the secret value, or you can specify both the SecretStringTemplate and the GenerateSecretKeyparameters. Secrets Manager uses the value in GenerateSecretKeyparameters. Secrets Manager uses the value in GenerateSecretKey as the key name and combines it with the randomly generated password to make a JSON key-value pair. It then inserts that pair into the JSON structure that's specified in the SecretStringTemplateparameter. Secrets Manager stores the completed string as the secret value in the initial version of the secret. For more information about how to use this property, see Secrets Manager Secret GenerateSecretString: https://docs.aws.amazon.com/AWSCloudFormation/latest/userguide/aws-properties-secretsmanager-secret-generatesecretstring.html and the first example: https://docs.aws.amazon.com/AWSCloudFormation/latest/userguide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-generated in the following Examples section. +Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. + Type: GenerateSecretString Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-generatesecretstring UpdateType: Mutable .PARAMETER Tags + The list of user-defined tags that are associated with the secret. Use tags to manage your AWS resources. For additional information about tags, see TagResource: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 index 26ee5614f..872e5d29c 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 @@ -1,10 +1,16 @@ function New-VSSecretsManagerSecretTargetAttachment { <# .SYNOPSIS - Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. + Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. The AWS::SecretsManager::SecretTargetAttachmentresource completes the final link between a Secrets Manager secret and its associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order: .DESCRIPTION - Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. + Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. The AWS::SecretsManager::SecretTargetAttachmentresource completes the final link between a Secrets Manager secret and its associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order: + +1. Define the secret without referencing the service or database. You can't reference the service or database because it doesn't exist yet. + +1. Next, define the service or database. Include the reference to the secret to use its stored credentials to define the database's master user and password. + +1. Finally, define a SecretTargetAttachmentresource type to finish configuring the secret with the required database engine type and the connection details of the service or database. These details are required by a rotation function, if one is attached later by defining a AWS::SecretsManager::RotationSchedule : https://docs.aws.amazon.com/AWSCloudFormation/latest/userguide/aws-resource-secretsmanager-rotationschedule.html resource type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html @@ -13,16 +19,22 @@ function New-VSSecretsManagerSecretTargetAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretId + The Amazon Resource Name ARN or the friendly name of the secret that contains the credentials that you want to use with the specified service or database. To reference a secret that's also created in this template, use the see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the secret's logical ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html#cfn-secretsmanager-secrettargetattachment-secretid PrimitiveType: String UpdateType: Mutable .PARAMETER TargetType + A string used by the Secrets Manager console to determine how to parse the structure of the secret text and place the values in the proper fields of the console user interface. If you created this secret using the Secrets Manager console then we recommend that you do not modify this value. If this is a custom secret, then this field is available for your use. As a best practice, do not store any sensitive information in this field. Instead, store sensitive information in the SecretString or SecretBinary fields to ensure that it is encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html#cfn-secretsmanager-secrettargetattachment-targettype PrimitiveType: String UpdateType: Mutable .PARAMETER TargetId + The ARN of the service or database whose credentials are stored in the specified secret. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html#cfn-secretsmanager-secrettargetattachment-targetid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 b/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 index 9feff91ab..16a0c124d 100644 --- a/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 @@ -1,10 +1,10 @@ function New-VSSecurityHubHub { <# .SYNOPSIS - Adds an AWS::SecurityHub::Hub resource to the template. + Adds an AWS::SecurityHub::Hub resource to the template. The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub. .DESCRIPTION - Adds an AWS::SecurityHub::Hub resource to the template. + Adds an AWS::SecurityHub::Hub resource to the template. The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html @@ -13,6 +13,8 @@ function New-VSSecurityHubHub { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + The tags to add to the hub resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html#cfn-securityhub-hub-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 index 6f9992072..0b9cd21a2 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogAcceptedPortfolioShare { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::AcceptedPortfolioShare resource to the template. + Adds an AWS::ServiceCatalog::AcceptedPortfolioShare resource to the template. Accepts an offer to share the specified portfolio. .DESCRIPTION - Adds an AWS::ServiceCatalog::AcceptedPortfolioShare resource to the template. + Adds an AWS::ServiceCatalog::AcceptedPortfolioShare resource to the template. Accepts an offer to share the specified portfolio. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-acceptedportfolioshare.html @@ -13,11 +13,18 @@ function New-VSServiceCatalogAcceptedPortfolioShare { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-acceptedportfolioshare.html#cfn-servicecatalog-acceptedportfolioshare-acceptlanguage PrimitiveType: String UpdateType: Immutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-acceptedportfolioshare.html#cfn-servicecatalog-acceptedportfolioshare-portfolioid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 index d530b2df1..fb1b13c17 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogCloudFormationProduct { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::CloudFormationProduct resource to the template. + Adds an AWS::ServiceCatalog::CloudFormationProduct resource to the template. Specifies a product. .DESCRIPTION - Adds an AWS::ServiceCatalog::CloudFormationProduct resource to the template. + Adds an AWS::ServiceCatalog::CloudFormationProduct resource to the template. Specifies a product. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html @@ -13,52 +13,75 @@ function New-VSServiceCatalogCloudFormationProduct { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Owner + The owner of the product. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-owner PrimitiveType: String UpdateType: Mutable .PARAMETER SupportDescription + The support information about the product. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportdescription PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description of the product. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-description PrimitiveType: String UpdateType: Mutable .PARAMETER Distributor + The distributor of the product. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-distributor PrimitiveType: String UpdateType: Mutable .PARAMETER SupportEmail + The contact email for product support. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportemail PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER SupportUrl + The contact URL for product support. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supporturl PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + One or more tags. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name of the product. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-name PrimitiveType: String UpdateType: Mutable .PARAMETER ProvisioningArtifactParameters + The configuration of the provisioning artifact also known as a version. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactparameters ItemType: ProvisioningArtifactProperties diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 index eec262536..508d579b6 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 @@ -1,10 +1,14 @@ function New-VSServiceCatalogCloudFormationProvisionedProduct { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct resource to the template. + Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct resource to the template. Provisions the specified product. .DESCRIPTION - Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct resource to the template. + Adds an AWS::ServiceCatalog::CloudFormationProvisionedProduct resource to the template. Provisions the specified product. + +A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord: https://docs.aws.amazon.com/servicecatalog/latest/dg/API_DescribeRecord.html. + +If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags*N*]:*Value*". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html @@ -13,59 +17,90 @@ function New-VSServiceCatalogCloudFormationProvisionedProduct { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PathId + The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths: https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-pathid PrimitiveType: String UpdateType: Mutable .PARAMETER ProvisioningParameters + Parameters specified by the administrator that are required for provisioning the product. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameters ItemType: ProvisioningParameter UpdateType: Mutable .PARAMETER ProvisioningPreferences + StackSet preferences that are required for provisioning the product or updating a provisioned product. + Type: ProvisioningPreferences Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences UpdateType: Mutable .PARAMETER ProductName + A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned. +Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account/region with that ProductName. +You must specify either the name or the ID of the product, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-productname PrimitiveType: String UpdateType: Mutable .PARAMETER ProvisioningArtifactName + The name of the provisioning artifact also known as a version for the product. This name must be unique for the product. +You must specify either the name or the ID of the provisioning artifact, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningartifactname PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationArns + Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-notificationarns UpdateType: Immutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER ProductId + The product identifier. +You must specify either the ID or the name of the product, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-productid PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + One or more tags. +Requires the provisioned product to have an ResourceUpdateConstraint: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-tags ItemType: Tag UpdateType: Mutable .PARAMETER ProvisionedProductName + A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisionedproductname PrimitiveType: String UpdateType: Immutable .PARAMETER ProvisioningArtifactId + The identifier of the provisioning artifact also known as a version. +You must specify either the ID or the name of the provisioning artifact, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningartifactid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 index c46a54a21..f80a3096f 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogLaunchNotificationConstraint { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::LaunchNotificationConstraint resource to the template. + Adds an AWS::ServiceCatalog::LaunchNotificationConstraint resource to the template. Specifies a notification constraint. .DESCRIPTION - Adds an AWS::ServiceCatalog::LaunchNotificationConstraint resource to the template. + Adds an AWS::ServiceCatalog::LaunchNotificationConstraint resource to the template. Specifies a notification constraint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html @@ -13,27 +13,40 @@ function New-VSServiceCatalogLaunchNotificationConstraint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the constraint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-description PrimitiveType: String UpdateType: Mutable .PARAMETER NotificationArns + The notification ARNs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-notificationarns UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER ProductId + The product identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-productid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 index 5a6b0d91e..07db71105 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogLaunchRoleConstraint { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::LaunchRoleConstraint resource to the template. + Adds an AWS::ServiceCatalog::LaunchRoleConstraint resource to the template. Specifies a launch constraint. .DESCRIPTION - Adds an AWS::ServiceCatalog::LaunchRoleConstraint resource to the template. + Adds an AWS::ServiceCatalog::LaunchRoleConstraint resource to the template. Specifies a launch constraint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html @@ -13,26 +13,39 @@ function New-VSServiceCatalogLaunchRoleConstraint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the constraint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-description PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER ProductId + The product identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-productid PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn + The ARN of the launch role. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 index a99646c76..65a883143 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogLaunchTemplateConstraint { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::LaunchTemplateConstraint resource to the template. + Adds an AWS::ServiceCatalog::LaunchTemplateConstraint resource to the template. Specifies a template constraint. .DESCRIPTION - Adds an AWS::ServiceCatalog::LaunchTemplateConstraint resource to the template. + Adds an AWS::ServiceCatalog::LaunchTemplateConstraint resource to the template. Specifies a template constraint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html @@ -13,26 +13,39 @@ function New-VSServiceCatalogLaunchTemplateConstraint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the constraint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-description PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER ProductId + The product identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-productid PrimitiveType: String UpdateType: Immutable .PARAMETER Rules + The constraint rules. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-rules PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 index df6651fc9..ef627ef98 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogPortfolio { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::Portfolio resource to the template. + Adds an AWS::ServiceCatalog::Portfolio resource to the template. Specifies a portfolio. .DESCRIPTION - Adds an AWS::ServiceCatalog::Portfolio resource to the template. + Adds an AWS::ServiceCatalog::Portfolio resource to the template. Specifies a portfolio. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html @@ -13,26 +13,39 @@ function New-VSServiceCatalogPortfolio { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ProviderName + The name of the portfolio provider. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-providername PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description of the portfolio. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-description PrimitiveType: String UpdateType: Mutable .PARAMETER DisplayName + The name to use for display purposes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-displayname PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + One or more tags. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 index 385afe110..fa8c0692d 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogPortfolioPrincipalAssociation { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::PortfolioPrincipalAssociation resource to the template. + Adds an AWS::ServiceCatalog::PortfolioPrincipalAssociation resource to the template. Associates the specified principal ARN with the specified portfolio. .DESCRIPTION - Adds an AWS::ServiceCatalog::PortfolioPrincipalAssociation resource to the template. + Adds an AWS::ServiceCatalog::PortfolioPrincipalAssociation resource to the template. Associates the specified principal ARN with the specified portfolio. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html @@ -13,21 +13,32 @@ function New-VSServiceCatalogPortfolioPrincipalAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PrincipalARN + The ARN of the principal IAM user, role, or group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-principalarn PrimitiveType: String UpdateType: Immutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-acceptlanguage PrimitiveType: String UpdateType: Immutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER PrincipalType + The principal type. The supported value is IAM. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-principaltype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 index c23a2600a..fadabf7e5 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogPortfolioProductAssociation { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::PortfolioProductAssociation resource to the template. + Adds an AWS::ServiceCatalog::PortfolioProductAssociation resource to the template. Associates the specified product with the specified portfolio. .DESCRIPTION - Adds an AWS::ServiceCatalog::PortfolioProductAssociation resource to the template. + Adds an AWS::ServiceCatalog::PortfolioProductAssociation resource to the template. Associates the specified product with the specified portfolio. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html @@ -13,21 +13,32 @@ function New-VSServiceCatalogPortfolioProductAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SourcePortfolioId + The identifier of the source portfolio. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-sourceportfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-acceptlanguage PrimitiveType: String UpdateType: Immutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER ProductId + The product identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-productid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 index fb09129ce..b7a53c2ed 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogPortfolioShare { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::PortfolioShare resource to the template. + Adds an AWS::ServiceCatalog::PortfolioShare resource to the template. Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. .DESCRIPTION - Adds an AWS::ServiceCatalog::PortfolioShare resource to the template. + Adds an AWS::ServiceCatalog::PortfolioShare resource to the template. Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioshare.html @@ -13,16 +13,25 @@ function New-VSServiceCatalogPortfolioShare { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccountId + The AWS account ID. For example, 123456789012. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioshare.html#cfn-servicecatalog-portfolioshare-accountid PrimitiveType: String UpdateType: Immutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioshare.html#cfn-servicecatalog-portfolioshare-acceptlanguage PrimitiveType: String UpdateType: Immutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioshare.html#cfn-servicecatalog-portfolioshare-portfolioid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 index 866d76a56..ae6f44283 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogResourceUpdateConstraint { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::ResourceUpdateConstraint resource to the template. + Adds an AWS::ServiceCatalog::ResourceUpdateConstraint resource to the template. Specifies a RESOURCE_UPDATE constraint. .DESCRIPTION - Adds an AWS::ServiceCatalog::ResourceUpdateConstraint resource to the template. + Adds an AWS::ServiceCatalog::ResourceUpdateConstraint resource to the template. Specifies a RESOURCE_UPDATE constraint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html @@ -13,26 +13,40 @@ function New-VSServiceCatalogResourceUpdateConstraint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the constraint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html#cfn-servicecatalog-resourceupdateconstraint-description PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html#cfn-servicecatalog-resourceupdateconstraint-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER TagUpdateOnProvisionedProduct + If set to ALLOWED, lets users change tags in a CloudFormationProvisionedProduct: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html resource. +If set to NOT_ALLOWED, prevents users from changing tags in a CloudFormationProvisionedProduct: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html#cfn-servicecatalog-resourceupdateconstraint-tagupdateonprovisionedproduct PrimitiveType: String UpdateType: Mutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html#cfn-servicecatalog-resourceupdateconstraint-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER ProductId + The product identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html#cfn-servicecatalog-resourceupdateconstraint-productid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 index b07e5a4de..280f49f9c 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogStackSetConstraint { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::StackSetConstraint resource to the template. + Adds an AWS::ServiceCatalog::StackSetConstraint resource to the template. Specifies a StackSet constraint. .DESCRIPTION - Adds an AWS::ServiceCatalog::StackSetConstraint resource to the template. + Adds an AWS::ServiceCatalog::StackSetConstraint resource to the template. Specifies a StackSet constraint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html @@ -13,48 +13,72 @@ function New-VSServiceCatalogStackSetConstraint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the constraint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-description PrimitiveType: String UpdateType: Mutable .PARAMETER StackInstanceControl + Permission to create, update, and delete stack instances. Choose from ALLOWED and NOT_ALLOWED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-stackinstancecontrol PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptLanguage + The language code. ++ en - English default ++ jp - Japanese ++ zh - Chinese + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-acceptlanguage PrimitiveType: String UpdateType: Mutable .PARAMETER PortfolioId + The portfolio identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-portfolioid PrimitiveType: String UpdateType: Immutable .PARAMETER ProductId + The product identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-productid PrimitiveType: String UpdateType: Immutable .PARAMETER RegionList + One or more AWS Regions where the provisioned product will be available. +Applicable only to a CFN_STACKSET provisioned product type. +The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation. +If no values are specified, the default value is all regions from the STACKSET constraint. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-regionlist UpdateType: Mutable .PARAMETER AdminRole + AdminRole ARN + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-adminrole PrimitiveType: String UpdateType: Mutable .PARAMETER AccountList + One or more AWS accounts that will have access to the provisioned product. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-accountlist UpdateType: Mutable .PARAMETER ExecutionRole + ExecutionRole name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-stacksetconstraint.html#cfn-servicecatalog-stacksetconstraint-executionrole PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 index 71a86eb31..6dd80fe0c 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogTagOption { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::TagOption resource to the template. + Adds an AWS::ServiceCatalog::TagOption resource to the template. Specifies a TagOption. A TagOption is a key-value pair managed by AWS Service Catalog that serves as a template for creating an AWS tag. .DESCRIPTION - Adds an AWS::ServiceCatalog::TagOption resource to the template. + Adds an AWS::ServiceCatalog::TagOption resource to the template. Specifies a TagOption. A TagOption is a key-value pair managed by AWS Service Catalog that serves as a template for creating an AWS tag. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html @@ -13,16 +13,22 @@ function New-VSServiceCatalogTagOption { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Active + The TagOption active state. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html#cfn-servicecatalog-tagoption-active PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Value + The TagOption value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html#cfn-servicecatalog-tagoption-value PrimitiveType: String UpdateType: Immutable .PARAMETER Key + The TagOption key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html#cfn-servicecatalog-tagoption-key PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 index e6c6ada74..d278db74d 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSServiceCatalogTagOptionAssociation { <# .SYNOPSIS - Adds an AWS::ServiceCatalog::TagOptionAssociation resource to the template. + Adds an AWS::ServiceCatalog::TagOptionAssociation resource to the template. Associate the specified TagOption with the specified portfolio or product. .DESCRIPTION - Adds an AWS::ServiceCatalog::TagOptionAssociation resource to the template. + Adds an AWS::ServiceCatalog::TagOptionAssociation resource to the template. Associate the specified TagOption with the specified portfolio or product. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoptionassociation.html @@ -13,11 +13,15 @@ function New-VSServiceCatalogTagOptionAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TagOptionId + The TagOption identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoptionassociation.html#cfn-servicecatalog-tagoptionassociation-tagoptionid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceId + The resource identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoptionassociation.html#cfn-servicecatalog-tagoptionassociation-resourceid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 index f46bcc584..5a92d2409 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 @@ -1,10 +1,12 @@ function New-VSServiceDiscoveryHttpNamespace { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::HttpNamespace resource to the template. + Adds an AWS::ServiceDiscovery::HttpNamespace resource to the template. The HttpNamespace resource is a Cloud Map resource type that contains information about an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. .DESCRIPTION - Adds an AWS::ServiceDiscovery::HttpNamespace resource to the template. + Adds an AWS::ServiceDiscovery::HttpNamespace resource to the template. The HttpNamespace resource is a Cloud Map resource type that contains information about an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. + +For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html in the *AWS Cloud Map Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-httpnamespace.html @@ -13,11 +15,15 @@ function New-VSServiceDiscoveryHttpNamespace { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-httpnamespace.html#cfn-servicediscovery-httpnamespace-description PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name that you want to assign to this namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-httpnamespace.html#cfn-servicediscovery-httpnamespace-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 index 538f2ee03..f811f11ab 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 @@ -1,10 +1,10 @@ function New-VSServiceDiscoveryInstance { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Instance resource to the template. + Adds an AWS::ServiceDiscovery::Instance resource to the template. A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request. .DESCRIPTION - Adds an AWS::ServiceDiscovery::Instance resource to the template. + Adds an AWS::ServiceDiscovery::Instance resource to the template. A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html @@ -13,16 +13,53 @@ function New-VSServiceDiscoveryInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER InstanceAttributes + A string map that contains the following information for the service that you specify in ServiceId: ++ The attributes that apply to the records that are defined in the service. ++ For each attribute, the applicable value. +Supported attribute keys include the following: +**AWS_ALIAS_DNS_NAME** +**** +If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html. +Note the following: ++ The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both. ++ In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED. ++ If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record. ++ Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. ++ If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes. +**AWS_INSTANCE_CNAME** +If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. +This value is required if the service specified by ServiceId includes settings for an CNAME record. +**AWS_INSTANCE_IPV4** +If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. +This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. +**AWS_INSTANCE_IPV6** +If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. +This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. +**AWS_INSTANCE_PORT** +If the service includes an SRV record, the value that you want Route 53 to return for the port. +If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to. +This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceattributes PrimitiveType: Json UpdateType: Mutable .PARAMETER InstanceId + An identifier that you want to associate with the instance. Note the following: ++ If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord > Type: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type. ++ You can use this value to update an existing instance. ++ To register a new instance, you must specify a value that is unique among instances that you register by using the same service. ++ If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one. +**Note** +The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceid PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceId + The ID of the service that you want to use for settings for the instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-serviceid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 index a805a2e21..f8ae99e46 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 @@ -1,10 +1,10 @@ function New-VSServiceDiscoveryPrivateDnsNamespace { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::PrivateDnsNamespace resource to the template. + Adds an AWS::ServiceDiscovery::PrivateDnsNamespace resource to the template. Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html in the *AWS Cloud Map Developer Guide*. .DESCRIPTION - Adds an AWS::ServiceDiscovery::PrivateDnsNamespace resource to the template. + Adds an AWS::ServiceDiscovery::PrivateDnsNamespace resource to the template. Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html in the *AWS Cloud Map Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html @@ -13,16 +13,22 @@ function New-VSServiceDiscoveryPrivateDnsNamespace { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-description PrimitiveType: String UpdateType: Immutable .PARAMETER Vpc + The ID of the Amazon VPC that you want to associate the namespace with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-vpc PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 index 25df226cc..303cad84d 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 @@ -1,10 +1,10 @@ function New-VSServiceDiscoveryPublicDnsNamespace { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::PublicDnsNamespace resource to the template. + Adds an AWS::ServiceDiscovery::PublicDnsNamespace resource to the template. Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html in the *AWS Cloud Map Developer Guide*. .DESCRIPTION - Adds an AWS::ServiceDiscovery::PublicDnsNamespace resource to the template. + Adds an AWS::ServiceDiscovery::PublicDnsNamespace resource to the template. Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html in the *AWS Cloud Map Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html @@ -13,11 +13,15 @@ function New-VSServiceDiscoveryPublicDnsNamespace { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-description PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name that you want to assign to this namespace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 index 163a5750d..a1f73d9a5 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 @@ -1,10 +1,24 @@ function New-VSServiceDiscoveryService { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Service resource to the template. + Adds an AWS::ServiceDiscovery::Service resource to the template. A complex type that contains information about a service, which defines the configuration of the following entities: .DESCRIPTION - Adds an AWS::ServiceDiscovery::Service resource to the template. + Adds an AWS::ServiceDiscovery::Service resource to the template. A complex type that contains information about a service, which defines the configuration of the following entities: + ++ For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: + ++ A + ++ AAAA + ++ A and AAAA + ++ SRV + ++ CNAME + ++ Optionally, a health check .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html @@ -13,31 +27,45 @@ function New-VSServiceDiscoveryService { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-description PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckCustomConfig + A complex type that contains information about an optional custom health check. +If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. + Type: HealthCheckCustomConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckcustomconfig UpdateType: Immutable .PARAMETER DnsConfig + A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. + Type: DnsConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-dnsconfig UpdateType: Mutable .PARAMETER NamespaceId + The ID of the namespace that was used to create the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-namespaceid PrimitiveType: String UpdateType: Immutable .PARAMETER HealthCheckConfig + *Public DNS namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. +For information about the charges for health checks, see Amazon Route 53 Pricing: http://aws.amazon.com/route53/pricing/. + Type: HealthCheckConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckconfig UpdateType: Mutable .PARAMETER Name + The name of the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 b/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 index c339221db..c48321c0b 100644 --- a/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 @@ -1,10 +1,12 @@ function New-VSStepFunctionsActivity { <# .SYNOPSIS - Adds an AWS::StepFunctions::Activity resource to the template. + Adds an AWS::StepFunctions::Activity resource to the template. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. .DESCRIPTION - Adds an AWS::StepFunctions::Activity resource to the template. + Adds an AWS::StepFunctions::Activity resource to the template. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. + +For information about creating an activity, see Creating an Activity State Machine: https://docs.aws.amazon.com/step-functions/latest/dg/tutorial-creating-activity-state-machine.html in the *AWS Step Functions Developer Guide* and CreateActivity: https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html in the *AWS Step Functions API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html @@ -13,12 +15,23 @@ function New-VSStepFunctionsActivity { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags + The list of tags to add to a resource. +Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-tags ItemType: TagsEntry UpdateType: Mutable .PARAMETER Name + The name of the activity. +A name must *not* contain: ++ white space ++ brackets < > { } ] ++ wildcard characters ? * ++ special characters " # % ^ | ~ $ & , ; : / ++ control characters U+0000-001F, U+007F-009F + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 b/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 index 804bcaffa..d672ede89 100644 --- a/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 +++ b/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 @@ -1,10 +1,10 @@ function New-VSStepFunctionsStateMachine { <# .SYNOPSIS - Adds an AWS::StepFunctions::StateMachine resource to the template. + Adds an AWS::StepFunctions::StateMachine resource to the template. Provisions a state machine. A state machine consists of a collection of states that can do work (Task states, determine to which states to transition next (Choice states, stop an execution with an error (Fail states, and so on. State machines are specified using a JSON-based, structured language. .DESCRIPTION - Adds an AWS::StepFunctions::StateMachine resource to the template. + Adds an AWS::StepFunctions::StateMachine resource to the template. Provisions a state machine. A state machine consists of a collection of states that can do work (Task states, determine to which states to transition next (Choice states, stop an execution with an error (Fail states, and so on. State machines are specified using a JSON-based, structured language. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html @@ -13,6 +13,8 @@ function New-VSStepFunctionsStateMachine { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DefinitionString + The Amazon States Language definition of the state machine. See Amazon States Language: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring PrimitiveType: String UpdateType: Mutable @@ -23,16 +25,29 @@ function New-VSStepFunctionsStateMachine { UpdateType: Mutable .PARAMETER StateMachineName + The name of the state machine. +A name must *not* contain: ++ white space ++ brackets < > { } ] ++ wildcard characters ? * ++ special characters " # % ^ | ~ $ & , ; : / ++ control characters U+0000-001F, U+007F-009F + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn + The Amazon Resource Name ARN of the IAM role to use for this state machine. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The list of tags to add to a resource. +Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags ItemType: TagsEntry diff --git a/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 b/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 index 10f008e15..832bab887 100644 --- a/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 @@ -1,10 +1,10 @@ function New-VSTransferServer { <# .SYNOPSIS - Adds an AWS::Transfer::Server resource to the template. + Adds an AWS::Transfer::Server resource to the template. Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. .DESCRIPTION - Adds an AWS::Transfer::Server resource to the template. + Adds an AWS::Transfer::Server resource to the template. Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html @@ -13,31 +13,43 @@ function New-VSTransferServer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LoggingRole + A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-loggingrole PrimitiveType: String UpdateType: Mutable .PARAMETER IdentityProviderDetails + This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED. + Type: IdentityProviderDetails Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityproviderdetails UpdateType: Mutable .PARAMETER EndpointType + The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER EndpointDetails + The virtual private cloud VPC endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter. + Type: EndpointDetails Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointdetails UpdateType: Mutable .PARAMETER IdentityProviderType + Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityprovidertype PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Key-value pairs that can be used to group and search for servers. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 b/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 index 8bd25ec25..59fe8c04d 100644 --- a/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 @@ -1,10 +1,10 @@ function New-VSTransferUser { <# .SYNOPSIS - Adds an AWS::Transfer::User resource to the template. + Adds an AWS::Transfer::User resource to the template. Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. .DESCRIPTION - Adds an AWS::Transfer::User resource to the template. + Adds an AWS::Transfer::User resource to the template. Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html @@ -13,48 +13,69 @@ function New-VSTransferUser { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Policy + A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. +For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name ARN of the policy. You save the policy as a JSON blob and pass it in the Policy argument. +For an example of a scope-down policy, see Creating a Scope-Down Policy: https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down. +For more information, see AssumeRole: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html in the *AWS Security Token Service API Reference*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-policy PrimitiveType: String UpdateType: Mutable .PARAMETER Role + The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-role PrimitiveType: String UpdateType: Mutable .PARAMETER HomeDirectory + The landing directory folder for a user when they log in to the server using their SFTP client. An example is /home/username . + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectory PrimitiveType: String UpdateType: Mutable .PARAMETER HomeDirectoryType + An example UserName is sftp-user-1. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorytype PrimitiveType: String UpdateType: Mutable .PARAMETER ServerId + A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-serverid PrimitiveType: String UpdateType: Immutable .PARAMETER UserName + A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-username PrimitiveType: String UpdateType: Immutable .PARAMETER HomeDirectoryMappings + An example UserName is sftp-user-1. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorymappings ItemType: HomeDirectoryMapEntry UpdateType: Mutable .PARAMETER SshPublicKeys + This property contains the public key portion of the Secure Shell SSH keys stored for the described user. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-sshpublickeys ItemType: SshPublicKey UpdateType: Mutable .PARAMETER Tags + Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-tags ItemType: Tag diff --git a/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 index cd6ec9f86..01172df1c 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFByteMatchSet { <# .SYNOPSIS - Adds an AWS::WAF::ByteMatchSet resource to the template. + Adds an AWS::WAF::ByteMatchSet resource to the template. The AWS::WAF::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect. .DESCRIPTION - Adds an AWS::WAF::ByteMatchSet resource to the template. + Adds an AWS::WAF::ByteMatchSet resource to the template. The AWS::WAF::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html @@ -13,6 +13,8 @@ function New-VSWAFByteMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ByteMatchTuples + Specifies the bytes typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html#cfn-waf-bytematchset-bytematchtuples DuplicatesAllowed: False ItemType: ByteMatchTuple @@ -20,6 +22,8 @@ function New-VSWAFByteMatchSet { UpdateType: Mutable .PARAMETER Name + A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html#cfn-waf-bytematchset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 index 6b1090f9a..1f48efe7a 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 @@ -1,10 +1,12 @@ function New-VSWAFIPSet { <# .SYNOPSIS - Adds an AWS::WAF::IPSet resource to the template. + Adds an AWS::WAF::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. .DESCRIPTION - Adds an AWS::WAF::IPSet resource to the template. + Adds an AWS::WAF::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + +To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4 or /24, /32, /48, /56, /64, or /128 (for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html @@ -13,6 +15,8 @@ function New-VSWAFIPSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER IPSetDescriptors + The IP address type IPV4 or IPV6 and the IP address range in CIDR notation that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html#cfn-waf-ipset-ipsetdescriptors DuplicatesAllowed: False ItemType: IPSetDescriptor @@ -20,6 +24,8 @@ function New-VSWAFIPSet { UpdateType: Mutable .PARAMETER Name + A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html#cfn-waf-ipset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 index 28cf57086..19bf625fc 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalByteMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::ByteMatchSet resource to the template. + Adds an AWS::WAFRegional::ByteMatchSet resource to the template. The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect. .DESCRIPTION - Adds an AWS::WAFRegional::ByteMatchSet resource to the template. + Adds an AWS::WAFRegional::ByteMatchSet resource to the template. The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html @@ -13,12 +13,16 @@ function New-VSWAFRegionalByteMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ByteMatchTuples + Specifies the bytes typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-bytematchtuples ItemType: ByteMatchTuple UpdateType: Mutable .PARAMETER Name + A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 index 9869b131f..b63b069e6 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalGeoMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::GeoMatchSet resource to the template. + Adds an AWS::WAFRegional::GeoMatchSet resource to the template. Contains one or more countries that AWS WAF will search for. .DESCRIPTION - Adds an AWS::WAFRegional::GeoMatchSet resource to the template. + Adds an AWS::WAFRegional::GeoMatchSet resource to the template. Contains one or more countries that AWS WAF will search for. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html @@ -13,12 +13,16 @@ function New-VSWAFRegionalGeoMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GeoMatchConstraints + An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html#cfn-wafregional-geomatchset-geomatchconstraints ItemType: GeoMatchConstraint UpdateType: Mutable .PARAMETER Name + A friendly name or description of the AWS::WAFRegional::GeoMatchSet: #aws-resource-wafregional-geomatchset. You can't change the name of an GeoMatchSet after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html#cfn-wafregional-geomatchset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 index bed9c7c81..7de28347c 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 @@ -1,10 +1,12 @@ function New-VSWAFRegionalIPSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::IPSet resource to the template. + Adds an AWS::WAFRegional::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. .DESCRIPTION - Adds an AWS::WAFRegional::IPSet resource to the template. + Adds an AWS::WAFRegional::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + +To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4 or /24, /32, /48, /56, /64, or /128 (for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html @@ -13,12 +15,16 @@ function New-VSWAFRegionalIPSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER IPSetDescriptors + The IP address type IPV4 or IPV6 and the IP address range in CIDR notation that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html#cfn-wafregional-ipset-ipsetdescriptors ItemType: IPSetDescriptor UpdateType: Mutable .PARAMETER Name + A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html#cfn-wafregional-ipset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 index 32130109a..7e6dfd4a4 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 @@ -1,10 +1,18 @@ function New-VSWAFRegionalRateBasedRule { <# .SYNOPSIS - Adds an AWS::WAFRegional::RateBasedRule resource to the template. + Adds an AWS::WAFRegional::RateBasedRule resource to the template. A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions: .DESCRIPTION - Adds an AWS::WAFRegional::RateBasedRule resource to the template. + Adds an AWS::WAFRegional::RateBasedRule resource to the template. A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions: + ++ The requests come from 192.0.2.44. + ++ They contain the value BadBot in the User-Agent header. + +In the rule, you also define the rate limit as 15,000. + +Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count, which is defined in the web ACL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html @@ -13,27 +21,37 @@ function New-VSWAFRegionalRateBasedRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MetricName + A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-metricname PrimitiveType: String UpdateType: Immutable .PARAMETER RateLimit + The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratelimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER MatchPredicates + The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet> object that you want to include in a RateBasedRule. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-matchpredicates ItemType: Predicate UpdateType: Mutable .PARAMETER RateKey + The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratekey PrimitiveType: String UpdateType: Immutable .PARAMETER Name + A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 index e7fa22c9d..bb3c54e41 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalRegexPatternSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::RegexPatternSet resource to the template. + Adds an AWS::WAFRegional::RegexPatternSet resource to the template. The RegexPatternSet specifies the regular expression (regex pattern that you want AWS WAF to search for, such as Ba@]dBo0]t. You can then configure AWS WAF to reject those requests. .DESCRIPTION - Adds an AWS::WAFRegional::RegexPatternSet resource to the template. + Adds an AWS::WAFRegional::RegexPatternSet resource to the template. The RegexPatternSet specifies the regular expression (regex pattern that you want AWS WAF to search for, such as Ba@]dBo0]t. You can then configure AWS WAF to reject those requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html @@ -13,12 +13,16 @@ function New-VSWAFRegionalRegexPatternSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RegexPatternStrings + Specifies the regular expression regex patterns that you want AWS WAF to search for, such as Ba@]dBo0]t. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html#cfn-wafregional-regexpatternset-regexpatternstrings UpdateType: Mutable .PARAMETER Name + A friendly name or description of the AWS::WAFRegional::RegexPatternSet: #aws-resource-wafregional-regexpatternset. You can't change Name after you create a RegexPatternSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html#cfn-wafregional-regexpatternset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 index d5f7965e4..213babb9e 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 @@ -1,10 +1,16 @@ function New-VSWAFRegionalRule { <# .SYNOPSIS - Adds an AWS::WAFRegional::Rule resource to the template. + Adds an AWS::WAFRegional::Rule resource to the template. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: .DESCRIPTION - Adds an AWS::WAFRegional::Rule resource to the template. + Adds an AWS::WAFRegional::Rule resource to the template. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: + ++ An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44 + ++ A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot. + +To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html @@ -13,17 +19,23 @@ function New-VSWAFRegionalRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MetricName + A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-metricname PrimitiveType: String UpdateType: Immutable .PARAMETER Predicates + The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-predicates ItemType: Predicate UpdateType: Mutable .PARAMETER Name + The friendly name or description for the Rule. You can't change the name of a Rule after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 index 8bab581af..1114d61a4 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalSizeConstraintSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. + Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. .DESCRIPTION - Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. + Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html @@ -13,12 +13,16 @@ function New-VSWAFRegionalSizeConstraintSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SizeConstraints + The size constraint and the part of the web request to check. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html#cfn-wafregional-sizeconstraintset-sizeconstraints ItemType: SizeConstraint UpdateType: Mutable .PARAMETER Name + The name, if any, of the SizeConstraintSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html#cfn-wafregional-sizeconstraintset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 index 03e09f7cc..acd5a4e80 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalSqlInjectionMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. + Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. .DESCRIPTION - Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. + Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html @@ -13,12 +13,16 @@ function New-VSWAFRegionalSqlInjectionMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SqlInjectionMatchTuples + Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuples ItemType: SqlInjectionMatchTuple UpdateType: Mutable .PARAMETER Name + The name, if any, of the SqlInjectionMatchSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html#cfn-wafregional-sqlinjectionmatchset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 index 5add5a29f..03338883b 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalWebACL { <# .SYNOPSIS - Adds an AWS::WAFRegional::WebACL resource to the template. + Adds an AWS::WAFRegional::WebACL resource to the template. Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK, and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. .DESCRIPTION - Adds an AWS::WAFRegional::WebACL resource to the template. + Adds an AWS::WAFRegional::WebACL resource to the template. Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK, and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html @@ -13,22 +13,30 @@ function New-VSWAFRegionalWebACL { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MetricName + A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-metricname PrimitiveType: String UpdateType: Immutable .PARAMETER DefaultAction + The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object. + Type: Action Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-defaultaction UpdateType: Mutable .PARAMETER Rules + An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-rules ItemType: Rule UpdateType: Mutable .PARAMETER Name + A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 index 102010af4..7a0af0817 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalWebACLAssociation { <# .SYNOPSIS - Adds an AWS::WAFRegional::WebACLAssociation resource to the template. + Adds an AWS::WAFRegional::WebACLAssociation resource to the template. The AWS::WAFRegional::WebACLAssociation resource associates an AWS WAF Regional web access control group (ACL with a resource. .DESCRIPTION - Adds an AWS::WAFRegional::WebACLAssociation resource to the template. + Adds an AWS::WAFRegional::WebACLAssociation resource to the template. The AWS::WAFRegional::WebACLAssociation resource associates an AWS WAF Regional web access control group (ACL with a resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html @@ -13,11 +13,15 @@ function New-VSWAFRegionalWebACLAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResourceArn + The Amazon Resource Name ARN of the resource to protect with the web ACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html#cfn-wafregional-webaclassociation-resourcearn PrimitiveType: String UpdateType: Immutable .PARAMETER WebACLId + A unique identifier ID for the web ACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html#cfn-wafregional-webaclassociation-webaclid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 index 713e88a1d..21f2bd2ea 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFRegionalXssMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::XssMatchSet resource to the template. + Adds an AWS::WAFRegional::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. .DESCRIPTION - Adds an AWS::WAFRegional::XssMatchSet resource to the template. + Adds an AWS::WAFRegional::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html @@ -13,12 +13,16 @@ function New-VSWAFRegionalXssMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER XssMatchTuples + Specifies the parts of web requests that you want to inspect for cross-site scripting attacks. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html#cfn-wafregional-xssmatchset-xssmatchtuples ItemType: XssMatchTuple UpdateType: Mutable .PARAMETER Name + The name, if any, of the XssMatchSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html#cfn-wafregional-xssmatchset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 index 0da395517..5426c7f6d 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 @@ -1,10 +1,16 @@ function New-VSWAFRule { <# .SYNOPSIS - Adds an AWS::WAF::Rule resource to the template. + Adds an AWS::WAF::Rule resource to the template. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: .DESCRIPTION - Adds an AWS::WAF::Rule resource to the template. + Adds an AWS::WAF::Rule resource to the template. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: + ++ An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44 + ++ A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot. + +To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html @@ -13,16 +19,22 @@ function New-VSWAFRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER MetricName + A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-metricname PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The friendly name or description for the Rule. You can't change the name of a Rule after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-name PrimitiveType: String UpdateType: Immutable .PARAMETER Predicates + The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-predicates DuplicatesAllowed: False ItemType: Predicate diff --git a/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 index 76f4643d3..c2b16a70e 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFSizeConstraintSet { <# .SYNOPSIS - Adds an AWS::WAF::SizeConstraintSet resource to the template. + Adds an AWS::WAF::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. .DESCRIPTION - Adds an AWS::WAF::SizeConstraintSet resource to the template. + Adds an AWS::WAF::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html @@ -13,11 +13,15 @@ function New-VSWAFSizeConstraintSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name, if any, of the SizeConstraintSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html#cfn-waf-sizeconstraintset-name PrimitiveType: String UpdateType: Immutable .PARAMETER SizeConstraints + The size constraint and the part of the web request to check. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html#cfn-waf-sizeconstraintset-sizeconstraints DuplicatesAllowed: False ItemType: SizeConstraint diff --git a/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 index c8016cb10..dbc78ff93 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFSqlInjectionMatchSet { <# .SYNOPSIS - Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. + Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. .DESCRIPTION - Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. + Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html @@ -13,11 +13,15 @@ function New-VSWAFSqlInjectionMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name, if any, of the SqlInjectionMatchSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html#cfn-waf-sqlinjectionmatchset-name PrimitiveType: String UpdateType: Immutable .PARAMETER SqlInjectionMatchTuples + Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples DuplicatesAllowed: False ItemType: SqlInjectionMatchTuple diff --git a/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 index 16b689e9c..5259bf9f5 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 @@ -1,10 +1,10 @@ function New-VSWAFWebACL { <# .SYNOPSIS - Adds an AWS::WAF::WebACL resource to the template. + Adds an AWS::WAF::WebACL resource to the template. Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK, and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. .DESCRIPTION - Adds an AWS::WAF::WebACL resource to the template. + Adds an AWS::WAF::WebACL resource to the template. Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK, and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html @@ -13,21 +13,29 @@ function New-VSWAFWebACL { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DefaultAction + The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-defaultaction Type: WafAction UpdateType: Mutable .PARAMETER MetricName + A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-metricname PrimitiveType: String UpdateType: Immutable .PARAMETER Name + A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-name PrimitiveType: String UpdateType: Immutable .PARAMETER Rules + An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-rules DuplicatesAllowed: False ItemType: ActivatedRule diff --git a/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 index 97d370bfa..fec43f65e 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 @@ -1,10 +1,10 @@ function New-VSWAFXssMatchSet { <# .SYNOPSIS - Adds an AWS::WAF::XssMatchSet resource to the template. + Adds an AWS::WAF::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. .DESCRIPTION - Adds an AWS::WAF::XssMatchSet resource to the template. + Adds an AWS::WAF::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html @@ -13,11 +13,15 @@ function New-VSWAFXssMatchSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name, if any, of the XssMatchSet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html#cfn-waf-xssmatchset-name PrimitiveType: String UpdateType: Immutable .PARAMETER XssMatchTuples + Specifies the parts of web requests that you want to inspect for cross-site scripting attacks. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html#cfn-waf-xssmatchset-xssmatchtuples DuplicatesAllowed: False ItemType: XssMatchTuple diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 index c24ed4879..4ef0e21f4 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 @@ -35,12 +35,14 @@ function New-VSWAFv2IPSet { .PARAMETER Addresses Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-addresses UpdateType: Mutable - Type: IPAddresses + Type: List + PrimitiveItemType: String .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-tags UpdateType: Mutable - Type: TagList + Type: List + ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. @@ -134,6 +136,15 @@ function New-VSWAFv2IPSet { [parameter(Mandatory = $true)] $Addresses, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] @@ -192,6 +203,18 @@ function New-VSWAFv2IPSet { Condition { $ResourceParams.Add("Condition",$Condition) } + Addresses { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Addresses -Value @($Addresses) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 index 20c634c31..ce1e77783 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 @@ -25,7 +25,8 @@ function New-VSWAFv2RegexPatternSet { .PARAMETER RegularExpressionList Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-regularexpressionlist UpdateType: Mutable - Type: RegularExpressionList + Type: List + PrimitiveItemType: String .PARAMETER Scope Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-scope @@ -35,7 +36,8 @@ function New-VSWAFv2RegexPatternSet { .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-tags UpdateType: Mutable - Type: TagList + Type: List + ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. @@ -118,6 +120,15 @@ function New-VSWAFv2RegexPatternSet { })] $Scope, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] @@ -176,6 +187,18 @@ function New-VSWAFv2RegexPatternSet { Condition { $ResourceParams.Add("Condition",$Condition) } + RegularExpressionList { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name RegularExpressionList -Value @($RegularExpressionList) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 index 775087bdd..eabc9a104 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 @@ -35,7 +35,8 @@ function New-VSWAFv2RuleGroup { .PARAMETER Rules Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-rules UpdateType: Mutable - Type: Rules + Type: List + ItemType: Rule .PARAMETER VisibilityConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-visibilityconfig @@ -45,7 +46,8 @@ function New-VSWAFv2RuleGroup { .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-tags UpdateType: Mutable - Type: TagList + Type: List + ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. @@ -137,10 +139,28 @@ function New-VSWAFv2RuleGroup { })] $Scope, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.RuleGroup.Rule" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Rules, [parameter(Mandatory = $true)] $VisibilityConfig, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] @@ -199,6 +219,18 @@ function New-VSWAFv2RuleGroup { Condition { $ResourceParams.Add("Condition",$Condition) } + Rules { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Rules -Value @($Rules) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 index 9612f0c8d..ee992415f 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 @@ -35,7 +35,8 @@ function New-VSWAFv2WebACL { .PARAMETER Rules Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-rules UpdateType: Mutable - Type: Rules + Type: List + ItemType: Rule .PARAMETER VisibilityConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-visibilityconfig @@ -45,7 +46,8 @@ function New-VSWAFv2WebACL { .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tags UpdateType: Mutable - Type: TagList + Type: List + ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. @@ -128,10 +130,28 @@ function New-VSWAFv2WebACL { })] $Scope, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.WAFv2.WebACL.Rule" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Rules, [parameter(Mandatory = $true)] $VisibilityConfig, [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] @@ -190,6 +210,18 @@ function New-VSWAFv2WebACL { Condition { $ResourceParams.Add("Condition",$Condition) } + Rules { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Rules -Value @($Rules) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) diff --git a/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 b/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 index ab7008cd1..da8ff19f8 100644 --- a/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 @@ -1,10 +1,12 @@ function New-VSWorkSpacesWorkspace { <# .SYNOPSIS - Adds an AWS::WorkSpaces::Workspace resource to the template. + Adds an AWS::WorkSpaces::Workspace resource to the template. Specifies a WorkSpace. .DESCRIPTION - Adds an AWS::WorkSpaces::Workspace resource to the template. + Adds an AWS::WorkSpaces::Workspace resource to the template. Specifies a WorkSpace. + +Updates are not supported for the BundleId, RootVolumeEncryptionEnabled, UserVolumeEncryptionEnabled, or VolumeEncryptionKey properties. To update these properties, you must also update a property that triggers a replacement, such as the UserName property. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html @@ -13,21 +15,29 @@ function New-VSWorkSpacesWorkspace { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BundleId + The identifier of the bundle for the WorkSpace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-bundleid PrimitiveType: String UpdateType: Conditional .PARAMETER DirectoryId + The identifier of the AWS Directory Service directory for the WorkSpace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-directoryid PrimitiveType: String UpdateType: Conditional .PARAMETER RootVolumeEncryptionEnabled + Indicates whether the data stored on the root volume is encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-rootvolumeencryptionenabled PrimitiveType: Boolean UpdateType: Conditional .PARAMETER Tags + The tags for the WorkSpace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-tags DuplicatesAllowed: True ItemType: Tag @@ -35,21 +45,29 @@ function New-VSWorkSpacesWorkspace { UpdateType: Mutable .PARAMETER UserName + The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-username PrimitiveType: String UpdateType: Immutable .PARAMETER UserVolumeEncryptionEnabled + Indicates whether the data stored on the user volume is encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-uservolumeencryptionenabled PrimitiveType: Boolean UpdateType: Conditional .PARAMETER VolumeEncryptionKey + The KMS key used to encrypt data stored on your WorkSpace. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-volumeencryptionkey PrimitiveType: String UpdateType: Conditional .PARAMETER WorkspaceProperties + The WorkSpace properties. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-workspaceproperties Type: WorkspaceProperties UpdateType: Mutable diff --git a/VaporShell/VaporShell.psd1 b/VaporShell/VaporShell.psd1 index 67e4f1895..9f8d29cfb 100644 --- a/VaporShell/VaporShell.psd1 +++ b/VaporShell/VaporShell.psd1 @@ -12,7 +12,7 @@ RootModule = 'VaporShell.psm1' # Version number of this module. - ModuleVersion = '2.10.0' + ModuleVersion = '2.11.0' # ID used to uniquely identify this module GUID = 'd526494c-6e59-41ff-ad05-eedbc1473b6a' From f729996be7355b6cf0a673c089fae3f5847940df Mon Sep 17 00:00:00 2001 From: Nate Ferrell Date: Tue, 3 Mar 2020 00:54:24 -0600 Subject: [PATCH 2/6] [skip ci] added TransformTag.cs for #69 --- VaporShell/bin/TransformTag.cs | 77 ++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 VaporShell/bin/TransformTag.cs diff --git a/VaporShell/bin/TransformTag.cs b/VaporShell/bin/TransformTag.cs new file mode 100644 index 000000000..0ee6cf5f8 --- /dev/null +++ b/VaporShell/bin/TransformTag.cs @@ -0,0 +1,77 @@ +using System; +using System.Collections; +using System.Collections.Generic; +using System.Management.Automation; + +public class TransformTagAttribute : ArgumentTransformationAttribute { + private EngineIntrinsics engineIntrinsics; + + private IEnumerable InvokeAddVSTag(object key, object value) + { + var tags = this.engineIntrinsics.InvokeCommand.InvokeScript( + String.Format("Add-VSTag -Key '{0}' -Value '{1}'", key, value) + ); + + foreach (PSObject tag in tags) + { + yield return tag; + } + } + + private IEnumerable TransformHashtable(IDictionary inputData) + { + foreach (string key in inputData.Keys) + { + foreach (PSObject tag in this.InvokeAddVSTag(key, inputData[key])) + { + yield return tag; + } + } + } + + private IEnumerable TransformPSObject(PSObject inputData) + { + foreach (var property in inputData.Properties) + { + foreach (PSObject tag in this.InvokeAddVSTag(property.Name, property.Value)) + { + yield return tag; + } + } + } + + private object TransformData(object inputData) + { + if (inputData is Array) + { + foreach (object item in inputData as object[]) + { + return this.TransformData(item); + } + } + else if (inputData is IDictionary) + { + return this.TransformHashtable(inputData as IDictionary); + } + else if (inputData is PSObject) + { + PSObject psObject = inputData as PSObject; + if (psObject.TypeNames.Contains("Vaporshell.Resource.Tag")) + { + return inputData; + } + else if (psObject.TypeNames.Contains("System.Management.Automation.PSCustomObject")) + { + return this.TransformPSObject(psObject); + } + } + + return inputData; + } + + public override object Transform(EngineIntrinsics engineIntrinsics, object inputData) + { + this.engineIntrinsics = engineIntrinsics; + return this.TransformData(inputData); + } +} From d2365f59e18c517be5d9cbdbd2c7405a2c9257b1 Mon Sep 17 00:00:00 2001 From: Nate Ferrell Date: Wed, 4 Mar 2020 02:31:48 -0600 Subject: [PATCH 3/6] pushing current state to test build success in CI --- Add-FnCidr.ps1 | 77 ++++++ Add-FnTransform.ps1 | 60 +++++ VaporShell.Core/VaporShell.Core.cs | 120 +++++++++ VaporShell.Core/VaporShell.Core.csproj | 10 + VaporShell/Private/PseudoParams.txt | 4 +- ...CACertificateAuthorityCrlConfiguration.ps1 | 48 +++- ...ficateAuthorityRevocationConfiguration.ps1 | 6 +- ...dd-VSACMPCACertificateAuthoritySubject.ps1 | 32 ++- .../Add-VSACMPCACertificateValidity.ps1 | 16 +- ...dd-VSAccessAnalyzerAnalyzerArchiveRule.ps1 | 8 +- .../Add-VSAccessAnalyzerAnalyzerFilter.ps1 | 14 +- ...exaASKSkillAuthenticationConfiguration.ps1 | 6 +- .../Add-VSAlexaASKSkillSkillPackage.ps1 | 2 +- ...d-VSAmplifyAppAutoBranchCreationConfig.ps1 | 9 +- ...VSApiGatewayDeploymentAccessLogSetting.ps1 | 2 +- ...VSApiGatewayDeploymentStageDescription.ps1 | 10 +- .../Add-VSApiGatewayMethodIntegration.ps1 | 2 +- ...ApiGatewayRestApiEndpointConfiguration.ps1 | 2 +- .../Add-VSApiGatewayStageAccessLogSetting.ps1 | 2 +- .../Add-VSApiGatewayV2ApiBodyS3Location.ps1 | 12 +- .../Add-VSApiGatewayV2ApiCors.ps1 | 16 +- ...ApiGatewayV2AuthorizerJWTConfiguration.ps1 | 8 +- ...wayV2DomainNameDomainNameConfiguration.ps1 | 4 +- .../Add-VSApiGatewayV2StageRouteSettings.ps1 | 8 +- .../Add-VSAppConfigApplicationTags.ps1 | 8 +- ...dd-VSAppConfigConfigurationProfileTags.ps1 | 8 +- ...ppConfigConfigurationProfileValidators.ps1 | 8 +- .../Add-VSAppConfigDeploymentStrategyTags.ps1 | 8 +- .../Add-VSAppConfigDeploymentTags.ps1 | 8 +- .../Add-VSAppConfigEnvironmentMonitors.ps1 | 8 +- .../Add-VSAppConfigEnvironmentTags.ps1 | 8 +- .../Add-VSAppMeshMeshEgressFilter.ps1 | 4 +- .../Add-VSAppMeshMeshMeshSpec.ps1 | 4 +- .../Add-VSAppMeshRouteDuration.ps1 | 8 +- .../Add-VSAppMeshRouteGrpcRetryPolicy.ps1 | 18 +- .../Add-VSAppMeshRouteGrpcRoute.ps1 | 10 +- .../Add-VSAppMeshRouteGrpcRouteAction.ps1 | 6 +- .../Add-VSAppMeshRouteGrpcRouteMatch.ps1 | 10 +- .../Add-VSAppMeshRouteGrpcRouteMetadata.ps1 | 10 +- ...pMeshRouteGrpcRouteMetadataMatchMethod.ps1 | 14 +- .../Add-VSAppMeshRouteHeaderMatchMethod.ps1 | 14 +- .../Add-VSAppMeshRouteHttpRetryPolicy.ps1 | 16 +- .../Add-VSAppMeshRouteHttpRoute.ps1 | 10 +- .../Add-VSAppMeshRouteHttpRouteAction.ps1 | 6 +- .../Add-VSAppMeshRouteHttpRouteHeader.ps1 | 6 +- .../Add-VSAppMeshRouteHttpRouteMatch.ps1 | 10 +- .../Add-VSAppMeshRouteMatchRange.ps1 | 4 +- .../Add-VSAppMeshRouteRouteSpec.ps1 | 14 +- .../Add-VSAppMeshRouteTcpRoute.ps1 | 4 +- .../Add-VSAppMeshRouteTcpRouteAction.ps1 | 6 +- .../Add-VSAppMeshRouteWeightedTarget.ps1 | 4 +- .../Add-VSAppMeshVirtualNodeAccessLog.ps1 | 4 +- ...irtualNodeAwsCloudMapInstanceAttribute.ps1 | 4 +- ...VirtualNodeAwsCloudMapServiceDiscovery.ps1 | 4 +- .../Add-VSAppMeshVirtualNodeBackend.ps1 | 4 +- ...dd-VSAppMeshVirtualNodeBackendDefaults.ps1 | 45 ++++ .../Add-VSAppMeshVirtualNodeClientPolicy.ps1 | 45 ++++ ...dd-VSAppMeshVirtualNodeClientPolicyTls.ps1 | 69 +++++ ...SAppMeshVirtualNodeDnsServiceDiscovery.ps1 | 4 +- .../Add-VSAppMeshVirtualNodeFileAccessLog.ps1 | 4 +- .../Add-VSAppMeshVirtualNodeHealthCheck.ps1 | 8 +- .../Add-VSAppMeshVirtualNodeListener.ps1 | 13 +- .../Add-VSAppMeshVirtualNodeListenerTls.ps1 | 61 +++++ ...shVirtualNodeListenerTlsAcmCertificate.ps1 | 54 ++++ ...pMeshVirtualNodeListenerTlsCertificate.ps1 | 52 ++++ ...hVirtualNodeListenerTlsFileCertificate.ps1 | 70 +++++ .../Add-VSAppMeshVirtualNodeLogging.ps1 | 4 +- .../Add-VSAppMeshVirtualNodePortMapping.ps1 | 2 +- ...d-VSAppMeshVirtualNodeServiceDiscovery.ps1 | 4 +- ...AppMeshVirtualNodeTlsValidationContext.ps1 | 45 ++++ ...irtualNodeTlsValidationContextAcmTrust.ps1 | 46 ++++ ...rtualNodeTlsValidationContextFileTrust.ps1 | 54 ++++ ...shVirtualNodeTlsValidationContextTrust.ps1 | 52 ++++ ...dd-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 | 17 +- ...ppMeshVirtualNodeVirtualServiceBackend.ps1 | 13 +- .../Add-VSAppMeshVirtualRouterPortMapping.ps1 | 2 +- ...MeshVirtualRouterVirtualRouterListener.ps1 | 4 +- ...SAppMeshVirtualRouterVirtualRouterSpec.ps1 | 6 +- ...rtualServiceVirtualNodeServiceProvider.ps1 | 4 +- ...ualServiceVirtualRouterServiceProvider.ps1 | 4 +- ...shVirtualServiceVirtualServiceProvider.ps1 | 4 +- ...ppMeshVirtualServiceVirtualServiceSpec.ps1 | 4 +- ...-VSAppStreamImageBuilderAccessEndpoint.ps1 | 8 +- .../Add-VSAppStreamStackAccessEndpoint.ps1 | 8 +- ...Add-VSAppSyncDataSourceDeltaSyncConfig.ps1 | 10 +- .../Add-VSAppSyncDataSourceDynamoDBConfig.ps1 | 4 +- ...AppSyncDataSourceRdsHttpEndpointConfig.ps1 | 2 +- .../Add-VSAppSyncResolverCachingConfig.ps1 | 10 +- ...yncResolverLambdaConflictHandlerConfig.ps1 | 6 +- .../Add-VSAppSyncResolverSyncConfig.ps1 | 15 +- ...toScalingScalableTargetScheduledAction.ps1 | 2 +- ...ngPolicyStepScalingPolicyConfiguration.ps1 | 15 +- ...rgetTrackingScalingPolicyConfiguration.ps1 | 30 ++- ...alingAutoScalingGroupMetricsCollection.ps1 | 4 +- ...oScalingGroupNotificationConfiguration.ps1 | 3 +- ...gLaunchConfigurationBlockDeviceMapping.ps1 | 3 +- ...ingPolicyPredefinedMetricSpecification.ps1 | 16 +- ...BackupBackupPlanBackupRuleResourceType.ps1 | 4 +- ...BackupBackupPlanCopyActionResourceType.ps1 | 8 +- ...atchComputeEnvironmentComputeResources.ps1 | 18 +- .../Add-VSBudgetsBudgetBudgetData.ps1 | 19 +- .../Add-VSBudgetsBudgetCostTypes.ps1 | 2 +- .../Add-VSBudgetsBudgetNotification.ps1 | 2 +- ...-VSCloudFrontDistributionCacheBehavior.ps1 | 8 +- .../Add-VSCloudFrontDistributionCookies.ps1 | 2 +- ...udFrontDistributionCustomErrorResponse.ps1 | 5 +- ...dFrontDistributionDefaultCacheBehavior.ps1 | 8 +- ...oudFrontDistributionDistributionConfig.ps1 | 6 +- ...SCloudFrontDistributionForwardedValues.ps1 | 6 +- .../Add-VSCloudFrontDistributionOrigin.ps1 | 10 +- ...loudFrontDistributionViewerCertificate.ps1 | 70 ++--- ...ontStreamingDistributionTrustedSigners.ps1 | 12 +- .../Add-VSCloudTrailTrailDataResource.ps1 | 4 +- .../Add-VSCloudWatchAlarmMetricStat.ps1 | 8 +- .../Add-VSCodeBuildProjectArtifacts.ps1 | 2 + .../Add-VSCodeBuildProjectEnvironment.ps1 | 11 +- ...-VSCodeBuildProjectEnvironmentVariable.ps1 | 5 +- .../Add-VSCodeBuildProjectFilterGroup.ps1 | 2 +- .../Add-VSCodeBuildProjectLogsConfig.ps1 | 4 +- .../Add-VSCodeBuildProjectProjectCache.ps1 | 6 +- ...eBuildProjectProjectFileSystemLocation.ps1 | 16 +- ...VSCodeBuildProjectProjectSourceVersion.ps1 | 2 +- ...d-VSCodeBuildProjectRegistryCredential.ps1 | 2 +- .../Add-VSCodeBuildProjectSource.ps1 | 1 + ...CodeBuildReportGroupReportExportConfig.ps1 | 10 +- ...deBuildReportGroupS3ReportExportConfig.ps1 | 16 +- ...SCodeCommitRepositoryRepositoryTrigger.ps1 | 8 +- ...deDeployDeploymentGroupDeploymentStyle.ps1 | 1 + ...eDeployDeploymentGroupLoadBalancerInfo.ps1 | 2 +- ...eDeployDeploymentGroupRevisionLocation.ps1 | 1 + ...ustomActionTypeConfigurationProperties.ps1 | 8 +- ...VSCodePipelineCustomActionTypeSettings.ps1 | 4 +- ...SCodePipelinePipelineActionDeclaration.ps1 | 11 +- ...Add-VSCodePipelinePipelineActionTypeId.ps1 | 10 +- ...dd-VSCodePipelinePipelineArtifactStore.ps1 | 12 +- ...VSCodePipelinePipelineArtifactStoreMap.ps1 | 11 +- ...dd-VSCodePipelinePipelineEncryptionKey.ps1 | 3 +- ...dd-VSCodePipelinePipelineInputArtifact.ps1 | 2 +- ...-VSCodePipelinePipelineStageTransition.ps1 | 2 +- ...ipelineWebhookWebhookAuthConfiguration.ps1 | 2 +- ...VSCodePipelineWebhookWebhookFilterRule.ps1 | 4 +- ...tarNotificationsNotificationRuleTarget.ps1 | 8 +- ...itoIdentityPoolCognitoIdentityProvider.ps1 | 6 +- ...dd-VSCognitoIdentityPoolCognitoStreams.ps1 | 2 +- .../Add-VSCognitoIdentityPoolPushSync.ps1 | 4 +- ...oIdentityPoolRoleAttachmentMappingRule.ps1 | 4 +- ...oIdentityPoolRoleAttachmentRoleMapping.ps1 | 11 +- ...olRoleAttachmentRulesConfigurationType.ps1 | 2 +- ...SCognitoUserPoolAccountRecoverySetting.ps1 | 6 +- ...VSCognitoUserPoolAdminCreateUserConfig.ps1 | 4 +- ...toUserPoolClientAnalyticsConfiguration.ps1 | 8 +- ...d-VSCognitoUserPoolDeviceConfiguration.ps1 | 4 +- ...toUserPoolDomainCustomDomainConfigType.ps1 | 6 +- ...dd-VSCognitoUserPoolEmailConfiguration.ps1 | 10 +- ...VSCognitoUserPoolInviteMessageTemplate.ps1 | 4 +- .../Add-VSCognitoUserPoolLambdaConfig.ps1 | 16 +- ...nitoUserPoolNumberAttributeConstraints.ps1 | 4 +- .../Add-VSCognitoUserPoolPasswordPolicy.ps1 | 4 +- .../Add-VSCognitoUserPoolPolicies.ps1 | 4 +- .../Add-VSCognitoUserPoolRecoveryOption.ps1 | 8 +- ...lResourceServerResourceServerScopeType.ps1 | 8 +- ...ionAttachmentAccountTakeoverActionType.ps1 | 12 +- ...onAttachmentAccountTakeoverActionsType.ps1 | 10 +- ...ntAccountTakeoverRiskConfigurationType.ps1 | 8 +- ...hmentCompromisedCredentialsActionsType.ps1 | 6 +- ...omisedCredentialsRiskConfigurationType.ps1 | 8 +- ...ationAttachmentNotifyConfigurationType.ps1 | 16 +- ...ConfigurationAttachmentNotifyEmailType.ps1 | 10 +- ...tachmentRiskExceptionConfigurationType.ps1 | 8 +- .../Add-VSCognitoUserPoolSchemaAttribute.ps1 | 7 +- .../Add-VSCognitoUserPoolSmsConfiguration.ps1 | 9 +- ...nitoUserPoolStringAttributeConstraints.ps1 | 4 +- ...Add-VSCognitoUserPoolUserAttributeType.ps1 | 4 +- .../Add-VSCognitoUserPoolUserPoolAddOns.ps1 | 4 +- ...VSCognitoUserPoolUsernameConfiguration.ps1 | 6 +- ...itoUserPoolVerificationMessageTemplate.ps1 | 4 +- ...mancePackConformancePackInputParameter.ps1 | 8 +- ...mancePackConformancePackInputParameter.ps1 | 8 +- ...ediationConfigurationExecutionControls.ps1 | 6 +- ...figRemediationConfigurationSsmControls.ps1 | 8 +- ...fecyclePolicyCrossRegionCopyRetainRule.ps1 | 8 +- ...SDLMLifecyclePolicyCrossRegionCopyRule.ps1 | 14 +- ...dd-VSDLMLifecyclePolicyFastRestoreRule.ps1 | 12 +- .../Add-VSDLMLifecyclePolicyParameters.ps1 | 6 +- .../Add-VSDLMLifecyclePolicyPolicyDetails.ps1 | 16 +- .../Add-VSDLMLifecyclePolicyRetainRule.ps1 | 10 +- .../Add-VSDLMLifecyclePolicySchedule.ps1 | 30 +-- ...Add-VSDMSEndpointElasticsearchSettings.ps1 | 2 +- .../Add-VSDMSEndpointMongoDbSettings.ps1 | 8 +- .../Add-VSDMSEndpointS3Settings.ps1 | 4 +- ...dd-VSDynamoDBTableGlobalSecondaryIndex.ps1 | 2 +- .../Add-VSDynamoDBTableKeySchema.ps1 | 2 +- ...Add-VSDynamoDBTableLocalSecondaryIndex.ps1 | 2 +- .../Add-VSDynamoDBTableProjection.ps1 | 2 +- .../Add-VSDynamoDBTableSSESpecification.ps1 | 2 +- ...VSDynamoDBTableTimeToLiveSpecification.ps1 | 8 +- ...EC2CapacityReservationTagSpecification.ps1 | 10 +- ...VSEC2ClientVpnEndpointTagSpecification.ps1 | 10 +- ...eetFleetLaunchTemplateOverridesRequest.ps1 | 2 +- ...leetLaunchTemplateSpecificationRequest.ps1 | 2 +- .../Add-VSEC2EC2FleetSpotOptionsRequest.ps1 | 6 +- .../Add-VSEC2InstanceEbs.ps1 | 4 +- ...d-VSEC2InstanceElasticGpuSpecification.ps1 | 2 +- ...EC2InstanceElasticInferenceAccelerator.ps1 | 4 +- .../Add-VSEC2InstanceHibernationOptions.ps1 | 7 +- .../Add-VSEC2InstanceNetworkInterface.ps1 | 3 +- .../Add-VSEC2LaunchTemplateEbs.ps1 | 2 +- ...2LaunchTemplateElasticGpuSpecification.ps1 | 2 +- ...-VSEC2LaunchTemplateLaunchTemplateData.ps1 | 6 +- ...nchTemplateElasticInferenceAccelerator.ps1 | 3 +- ...Add-VSEC2LaunchTemplateMetadataOptions.ps1 | 15 +- .../Add-VSEC2LaunchTemplatePlacement.ps1 | 6 +- .../Add-VSEC2LaunchTemplateSpotOptions.ps1 | 1 + ...dd-VSEC2LaunchTemplateTagSpecification.ps1 | 10 +- ...calGatewayRouteTableVPCAssociationTags.ps1 | 16 +- .../Add-VSEC2SecurityGroupEgress.ps1 | 6 +- .../Add-VSEC2SecurityGroupIngress.ps1 | 4 +- .../Add-VSEC2SpotFleetEbsBlockDevice.ps1 | 9 +- ...tInstanceNetworkInterfaceSpecification.ps1 | 3 +- ...2SpotFleetSpotFleetLaunchSpecification.ps1 | 4 +- ...EC2SpotFleetSpotFleetRequestConfigData.ps1 | 9 +- ...SEC2SpotFleetSpotFleetTagSpecification.ps1 | 12 +- ...MirrorFilterRuleTrafficMirrorPortRange.ps1 | 8 +- ...onnectionVpnTunnelOptionsSpecification.ps1 | 6 +- .../Add-VSECSClusterClusterSetting.ps1 | 8 +- ...dd-VSECSServiceDeploymentConfiguration.ps1 | 4 +- .../Add-VSECSServiceDeploymentController.ps1 | 13 +- .../Add-VSECSServiceLoadBalancer.ps1 | 12 +- .../Add-VSECSServicePlacementConstraint.ps1 | 2 +- ...VSECSTaskDefinitionContainerDefinition.ps1 | 16 +- ...VSECSTaskDefinitionContainerDependency.ps1 | 2 +- ...askDefinitionDockerVolumeConfiguration.ps1 | 6 +- ...ECSTaskDefinitionFirelensConfiguration.ps1 | 12 +- ...SECSTaskDefinitionInferenceAccelerator.ps1 | 10 +- ...Add-VSECSTaskDefinitionLinuxParameters.ps1 | 7 +- ...dd-VSECSTaskDefinitionLogConfiguration.ps1 | 12 +- ...VSECSTaskDefinitionResourceRequirement.ps1 | 6 +- ...itionTaskDefinitionPlacementConstraint.ps1 | 2 +- .../Add-VSECSTaskDefinitionVolume.ps1 | 2 +- .../Add-VSECSTaskSetAwsVpcConfiguration.ps1 | 12 +- .../Add-VSECSTaskSetLoadBalancer.ps1 | 17 +- .../Add-VSECSTaskSetNetworkConfiguration.ps1 | 7 +- .../Add-VSECSTaskSetScale.ps1 | 8 +- .../Add-VSECSTaskSetServiceRegistry.ps1 | 12 +- .../Add-VSEFSFileSystemLifecyclePolicy.ps1 | 6 +- .../Add-VSEKSNodegroupRemoteAccess.ps1 | 8 +- .../Add-VSEKSNodegroupScalingConfig.ps1 | 10 +- ...-VSEMRClusterCloudWatchAlarmDefinition.ps1 | 2 +- .../Add-VSEMRClusterInstanceGroupConfig.ps1 | 3 +- ...Add-VSEMRClusterJobFlowInstancesConfig.ps1 | 3 +- .../Add-VSEMRClusterStepConfig.ps1 | 2 +- ...ceGroupConfigCloudWatchAlarmDefinition.ps1 | 2 +- ...tionApplicationResourceLifecycleConfig.ps1 | 1 + ...VSElasticLoadBalancingV2ListenerAction.ps1 | 8 +- ...icLoadBalancingV2ListenerForwardConfig.ps1 | 8 +- ...asticLoadBalancingV2ListenerRuleAction.ps1 | 8 +- ...adBalancingV2ListenerRuleForwardConfig.ps1 | 8 +- ...istenerRuleTargetGroupStickinessConfig.ps1 | 8 +- ...alancingV2ListenerRuleTargetGroupTuple.ps1 | 8 +- ...gV2ListenerTargetGroupStickinessConfig.ps1 | 8 +- ...oadBalancingV2ListenerTargetGroupTuple.ps1 | 8 +- ...ingV2LoadBalancerLoadBalancerAttribute.ps1 | 3 +- ...adBalancingV2LoadBalancerSubnetMapping.ps1 | 2 +- ...alancingV2TargetGroupTargetDescription.ps1 | 2 +- ...ncingV2TargetGroupTargetGroupAttribute.ps1 | 1 + ...dd-VSElasticsearchDomainCognitoOptions.ps1 | 12 +- ...searchDomainElasticsearchClusterConfig.ps1 | 2 +- ...ElasticsearchDomainLogPublishingOption.ps1 | 9 +- .../Add-VSElasticsearchDomainVPCOptions.ps1 | 2 +- ...ElasticsearchDomainZoneAwarenessConfig.ps1 | 6 +- .../Add-VSEventSchemasDiscovererTagsEntry.ps1 | 8 +- .../Add-VSEventSchemasRegistryTagsEntry.ps1 | 8 +- .../Add-VSEventSchemasSchemaTagsEntry.ps1 | 8 +- .../Add-VSEventsRuleAwsVpcConfiguration.ps1 | 6 +- .../Add-VSEventsRuleBatchArrayProperties.ps1 | 6 +- .../Add-VSEventsRuleBatchParameters.ps1 | 12 +- .../Add-VSEventsRuleBatchRetryStrategy.ps1 | 6 +- .../Add-VSEventsRuleEcsParameters.ps1 | 8 +- .../Add-VSEventsRuleInputTransformer.ps1 | 4 +- .../Add-VSEventsRuleNetworkConfiguration.ps1 | 2 +- .../Add-VSEventsRuleRunCommandParameters.ps1 | 4 +- .../Add-VSEventsRuleTarget.ps1 | 12 +- .../Add-VSFMSPolicyIEMap.ps1 | 6 +- .../Add-VSFMSPolicyPolicyTag.ps1 | 8 +- .../Add-VSFMSPolicyResourceTag.ps1 | 8 +- ...Add-VSFSxFileSystemLustreConfiguration.ps1 | 10 +- ...elfManagedActiveDirectoryConfiguration.ps1 | 22 +- ...dd-VSFSxFileSystemWindowsConfiguration.ps1 | 23 +- .../Add-VSGameLiftAliasRoutingStrategy.ps1 | 16 +- .../Add-VSGameLiftBuildS3Location.ps1 | 12 +- ...SGameLiftFleetCertificateConfiguration.ps1 | 6 +- .../Add-VSGameLiftFleetIpPermission.ps1 | 12 +- ...meLiftFleetResourceCreationLimitPolicy.ps1 | 8 +- ...dd-VSGameLiftFleetRuntimeConfiguration.ps1 | 12 +- .../Add-VSGameLiftFleetServerProcess.ps1 | 12 +- ...-VSGameLiftGameSessionQueueDestination.ps1 | 6 +- ...iftGameSessionQueuePlayerLatencyPolicy.ps1 | 8 +- ...ftMatchmakingConfigurationGameProperty.ps1 | 8 +- .../Add-VSGameLiftScriptS3Location.ps1 | 12 +- .../Add-VSGlueCrawlerCatalogTarget.ps1 | 8 +- .../Add-VSGlueCrawlerDynamoDBTarget.ps1 | 6 +- .../Add-VSGlueCrawlerTargets.ps1 | 4 +- .../Add-VSGlueDatabaseDatabaseInput.ps1 | 1 - .../Add-VSGlueJobNotificationProperty.ps1 | 6 +- .../Add-VSGluePartitionPartitionInput.ps1 | 1 + ...GlueSecurityConfigurationS3Encryptions.ps1 | 10 +- .../Add-VSGlueTriggerAction.ps1 | 6 +- .../Add-VSGlueTriggerCondition.ps1 | 4 +- .../Add-VSGlueTriggerNotificationProperty.ps1 | 6 +- ...DefinitionResourceDownloadOwnerSetting.ps1 | 70 +++++ ...tionS3MachineLearningModelResourceData.ps1 | 9 + ...eMakerMachineLearningModelResourceData.ps1 | 11 +- ...ionVersionResourceDownloadOwnerSetting.ps1 | 70 +++++ ...sionS3MachineLearningModelResourceData.ps1 | 9 + ...eMakerMachineLearningModelResourceData.ps1 | 11 +- ...rassSubscriptionDefinitionSubscription.ps1 | 4 +- ...scriptionDefinitionVersionSubscription.ps1 | 4 +- ...nDataflowEndpointGroupDataflowEndpoint.ps1 | 61 +++++ ...onDataflowEndpointGroupEndpointDetails.ps1 | 52 ++++ ...onDataflowEndpointGroupSecurityDetails.ps1 | 70 +++++ ...tionDataflowEndpointGroupSocketAddress.ps1 | 70 +++++ ...roundStationMissionProfileDataflowEdge.ps1 | 70 +++++ ...d-VSIoTAnalyticsChannelRetentionPeriod.ps1 | 2 +- ...yticsDatasetDatasetContentDeliveryRule.ps1 | 8 +- ...tDatasetContentDeliveryRuleDestination.ps1 | 8 +- ...yticsDatasetDatasetContentVersionValue.ps1 | 6 +- .../Add-VSIoTAnalyticsDatasetDeltaTime.ps1 | 4 +- ...VSIoTAnalyticsDatasetGlueConfiguration.ps1 | 8 +- ...tasetIotEventsDestinationConfiguration.ps1 | 8 +- ...SIoTAnalyticsDatasetOutputFileUriValue.ps1 | 2 +- ...TAnalyticsDatasetResourceConfiguration.ps1 | 8 +- ...d-VSIoTAnalyticsDatasetRetentionPeriod.ps1 | 2 +- ...yticsDatasetS3DestinationConfiguration.ps1 | 12 +- ...VSIoTAnalyticsDatasetTriggeringDataset.ps1 | 4 +- .../Add-VSIoTAnalyticsDatasetVariable.ps1 | 6 +- ...nalyticsDatasetVersioningConfiguration.ps1 | 8 +- ...VSIoTAnalyticsDatastoreRetentionPeriod.ps1 | 2 +- .../Add-VSIoTAnalyticsPipelineDatastore.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelAction.ps1 | 4 +- .../Add-VSIoTEventsDetectorModelEvent.ps1 | 6 +- .../Add-VSIoTEventsDetectorModelState.ps1 | 6 +- ...SIoTEventsDetectorModelTransitionEvent.ps1 | 6 +- .../Add-VSIoTEventsInputAttribute.ps1 | 6 +- .../Add-VSIoTEventsInputInputDefinition.ps1 | 2 +- ...csV2ApplicationCheckpointConfiguration.ps1 | 15 +- ...plicationFlinkApplicationConfiguration.ps1 | 2 +- ...csV2ApplicationMonitoringConfiguration.ps1 | 2 +- ...sV2ApplicationParallelismConfiguration.ps1 | 6 +- ...esisFirehoseDeliveryStreamParquetSerDe.ps1 | 2 +- ...LakeFormationPermissionsColumnWildcard.ps1 | 6 +- ...rmationPermissionsDataLocationResource.ps1 | 6 +- ...ionPermissionsTableWithColumnsResource.ps1 | 12 +- ...iasProvisionedConcurrencyConfiguration.ps1 | 6 +- .../Add-VSLambdaAliasVersionWeight.ps1 | 4 +- ...mbdaEventInvokeConfigDestinationConfig.ps1 | 8 +- ...Add-VSLambdaEventInvokeConfigOnFailure.ps1 | 6 +- ...Add-VSLambdaEventInvokeConfigOnSuccess.ps1 | 6 +- ...bdaEventSourceMappingDestinationConfig.ps1 | 6 +- ...dd-VSLambdaEventSourceMappingOnFailure.ps1 | 6 +- .../Add-VSLambdaFunctionCode.ps1 | 2 +- .../Add-VSLambdaFunctionDeadLetterConfig.ps1 | 4 +- .../Add-VSLambdaFunctionTracingConfig.ps1 | 4 +- .../Add-VSLambdaFunctionVpcConfig.ps1 | 10 +- ...ionProvisionedConcurrencyConfiguration.ps1 | 6 +- ...VSLogsMetricFilterMetricTransformation.ps1 | 2 +- .../Add-VSMSKClusterBrokerNodeGroupInfo.ps1 | 13 +- .../Add-VSMSKClusterJmxExporter.ps1 | 6 +- .../Add-VSMSKClusterNodeExporter.ps1 | 6 +- .../Add-VSMSKClusterOpenMonitoring.ps1 | 6 +- .../Add-VSMSKClusterPrometheus.ps1 | 8 +- ...ConvertJobTemplateAccelerationSettings.ps1 | 6 +- ...iplexProgramChannelDestinationSettings.ps1 | 8 +- ...dd-VSMediaLiveChannelOutputDestination.ps1 | 2 +- ...dd-VSPinpointApplicationSettingsLimits.ps1 | 4 +- ...d-VSPinpointCampaignAttributeDimension.ps1 | 4 +- ...VSPinpointCampaignCampaignEmailMessage.ps1 | 4 +- ...-VSPinpointCampaignCampaignEventFilter.ps1 | 2 +- .../Add-VSPinpointCampaignEventDimensions.ps1 | 6 +- .../Add-VSPinpointCampaignLimits.ps1 | 4 +- .../Add-VSPinpointCampaignMessage.ps1 | 2 +- ...VSPinpointCampaignMessageConfiguration.ps1 | 2 +- .../Add-VSPinpointCampaignMetricDimension.ps1 | 4 +- .../Add-VSPinpointCampaignSchedule.ps1 | 10 +- .../Add-VSPinpointCampaignSetDimension.ps1 | 6 +- ...PinpointCampaignWriteTreatmentResource.ps1 | 2 +- ...shTemplateAPNSPushNotificationTemplate.ps1 | 19 +- ...emplateAndroidPushNotificationTemplate.ps1 | 23 +- ...emplateDefaultPushNotificationTemplate.ps1 | 18 +- ...dd-VSPinpointSegmentAttributeDimension.ps1 | 4 +- .../Add-VSPinpointSegmentBehavior.ps1 | 6 +- .../Add-VSPinpointSegmentCoordinates.ps1 | 4 +- .../Add-VSPinpointSegmentDemographic.ps1 | 4 +- .../Add-VSPinpointSegmentGPSPoint.ps1 | 4 +- .../Add-VSPinpointSegmentGroups.ps1 | 9 +- .../Add-VSPinpointSegmentLocation.ps1 | 6 +- .../Add-VSPinpointSegmentRecency.ps1 | 9 +- .../Add-VSPinpointSegmentSegmentGroups.ps1 | 6 +- .../Add-VSPinpointSegmentSetDimension.ps1 | 6 +- .../Add-VSPinpointSegmentSourceSegments.ps1 | 10 +- ...Add-VSRDSDBClusterScalingConfiguration.ps1 | 6 +- .../Add-VSRDSDBInstanceDBInstanceRole.ps1 | 2 +- .../Add-VSRDSDBSecurityGroupIngress.ps1 | 6 +- ...dd-VSRDSOptionGroupOptionConfiguration.ps1 | 2 +- ...akerRobotApplicationRobotSoftwareSuite.ps1 | 8 +- ...imulationApplicationRobotSoftwareSuite.ps1 | 8 +- ...dd-VSRoute53HealthCheckAlarmIdentifier.ps1 | 4 +- ...-VSRoute53HealthCheckHealthCheckConfig.ps1 | 13 +- .../Add-VSRoute53HostedZoneVPC.ps1 | 14 +- .../Add-VSRoute53RecordSetAliasTarget.ps1 | 92 ++++--- .../Add-VSRoute53RecordSetGeoLocation.ps1 | 16 +- ...Add-VSRoute53RecordSetGroupAliasTarget.ps1 | 92 ++++--- ...Add-VSRoute53RecordSetGroupGeoLocation.ps1 | 16 +- .../Add-VSRoute53RecordSetGroupRecordSet.ps1 | 43 +-- ...essPointPublicAccessBlockConfiguration.ps1 | 19 +- .../Add-VSS3AccessPointVpcConfiguration.ps1 | 6 +- .../Add-VSS3BucketAnalyticsConfiguration.ps1 | 2 - .../Add-VSS3BucketCorsConfiguration.ps1 | 2 +- .../Add-VSS3BucketDefaultRetention.ps1 | 2 +- .../Add-VSS3BucketDestination.ps1 | 4 +- .../Add-VSS3BucketEncryptionConfiguration.ps1 | 2 +- .../Add-VSS3BucketInventoryConfiguration.ps1 | 2 +- ...-VSS3BucketNoncurrentVersionTransition.ps1 | 2 +- ...dd-VSS3BucketNotificationConfiguration.ps1 | 2 + .../Add-VSS3BucketObjectLockConfiguration.ps1 | 16 +- .../Add-VSS3BucketObjectLockRule.ps1 | 4 +- ...S3BucketPublicAccessBlockConfiguration.ps1 | 5 +- ...Add-VSS3BucketReplicationConfiguration.ps1 | 2 +- .../Add-VSS3BucketReplicationDestination.ps1 | 3 +- .../Add-VSS3BucketReplicationRule.ps1 | 6 +- .../Add-VSS3BucketRoutingRuleCondition.ps1 | 4 +- .../Add-VSS3BucketRule.ps1 | 4 +- .../Add-VSS3BucketS3KeyFilter.ps1 | 2 +- ...SS3BucketServerSideEncryptionByDefault.ps1 | 7 +- .../Add-VSS3BucketSourceSelectionCriteria.ps1 | 4 +- .../Add-VSS3BucketSseKmsEncryptedObjects.ps1 | 2 +- .../Add-VSS3BucketTransition.ps1 | 4 +- ...ionSetEventDestinationEventDestination.ps1 | 12 +- .../Add-VSSESReceiptRuleBounceAction.ps1 | 3 +- .../Add-VSSESReceiptRuleLambdaAction.ps1 | 3 +- .../Add-VSSESReceiptRuleRule.ps1 | 2 +- .../Add-VSSESReceiptRuleS3Action.ps1 | 3 +- .../Add-VSSESReceiptRuleSNSAction.ps1 | 3 +- .../Add-VSSESReceiptRuleStopAction.ps1 | 5 +- .../Add-VSSESReceiptRuleWorkmailAction.ps1 | 8 +- .../Add-VSSNSTopicSubscription.ps1 | 2 +- .../Add-VSSSMAssociationTarget.ps1 | 4 +- ...dd-VSSSMMaintenanceWindowTargetTargets.ps1 | 4 +- ...intenanceWindowStepFunctionsParameters.ps1 | 8 +- ...anceWindowTaskTaskInvocationParameters.ps1 | 2 +- .../Add-VSSSMPatchBaselineRule.ps1 | 1 + ...ResourceDataSyncAwsOrganizationsSource.ps1 | 8 +- ...Add-VSSSMResourceDataSyncS3Destination.ps1 | 14 +- .../Add-VSSSMResourceDataSyncSyncSource.ps1 | 12 +- ...geMakerEndpointConfigProductionVariant.ps1 | 6 +- ...Add-VSSageMakerEndpointVariantProperty.ps1 | 6 +- ...dd-VSSageMakerModelContainerDefinition.ps1 | 8 +- .../Add-VSSageMakerModelVpcConfig.ps1 | 3 +- ...tsManagerRotationScheduleRotationRules.ps1 | 4 +- ...cretsManagerSecretGenerateSecretString.ps1 | 22 +- ...Add-VSServiceDiscoveryServiceDnsConfig.ps1 | 1 + ...rviceDiscoveryServiceHealthCheckConfig.ps1 | 4 +- ...iscoveryServiceHealthCheckCustomConfig.ps1 | 2 - ...ionsStateMachineCloudWatchLogsLogGroup.ps1 | 8 +- ...tepFunctionsStateMachineLogDestination.ps1 | 8 +- ...ctionsStateMachineLoggingConfiguration.ps1 | 12 +- .../Resource Property Types/Add-VSTag.ps1 | 4 +- .../Add-VSTransferServerEndpointDetails.ps1 | 18 +- ...dd-VSTransferUserHomeDirectoryMapEntry.ps1 | 8 +- .../Add-VSWAFByteMatchSetByteMatchTuple.ps1 | 10 +- .../Add-VSWAFByteMatchSetFieldToMatch.ps1 | 8 +- .../Add-VSWAFIPSetIPSetDescriptor.ps1 | 8 +- ...SWAFRegionalByteMatchSetByteMatchTuple.ps1 | 10 +- ...-VSWAFRegionalByteMatchSetFieldToMatch.ps1 | 8 +- ...FRegionalGeoMatchSetGeoMatchConstraint.ps1 | 8 +- .../Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 | 8 +- ...egionalSizeConstraintSetSizeConstraint.ps1 | 10 +- ...njectionMatchSetSqlInjectionMatchTuple.ps1 | 10 +- ...-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 | 10 +- ...d-VSWAFSizeConstraintSetSizeConstraint.ps1 | 10 +- ...-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 | 8 +- ...njectionMatchSetSqlInjectionMatchTuple.ps1 | 10 +- .../Add-VSWAFWebACLWafAction.ps1 | 8 +- .../Add-VSWAFXssMatchSetXssMatchTuple.ps1 | 10 +- .../Add-VSWAFv2RuleGroupAndStatementOne.ps1 | 6 +- .../Add-VSWAFv2RuleGroupAndStatementTwo.ps1 | 6 +- ...Add-VSWAFv2RuleGroupByteMatchStatement.ps1 | 32 ++- .../Add-VSWAFv2RuleGroupFieldToMatch.ps1 | 21 +- .../Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 | 8 +- ...SWAFv2RuleGroupIPSetReferenceStatement.ps1 | 10 +- .../Add-VSWAFv2RuleGroupNotStatementOne.ps1 | 6 +- .../Add-VSWAFv2RuleGroupNotStatementTwo.ps1 | 6 +- .../Add-VSWAFv2RuleGroupOrStatementOne.ps1 | 6 +- .../Add-VSWAFv2RuleGroupOrStatementTwo.ps1 | 6 +- ...-VSWAFv2RuleGroupRateBasedStatementOne.ps1 | 12 +- ...-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 | 12 +- ...GroupRegexPatternSetReferenceStatement.ps1 | 14 +- .../Add-VSWAFv2RuleGroupRule.ps1 | 16 +- .../Add-VSWAFv2RuleGroupRuleAction.ps1 | 12 +- ...SWAFv2RuleGroupSizeConstraintStatement.ps1 | 18 +- ...Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 | 10 +- .../Add-VSWAFv2RuleGroupStatementOne.ps1 | 30 ++- .../Add-VSWAFv2RuleGroupStatementThree.ps1 | 20 +- .../Add-VSWAFv2RuleGroupStatementTwo.ps1 | 30 ++- ...Add-VSWAFv2RuleGroupTextTransformation.ps1 | 40 ++- .../Add-VSWAFv2RuleGroupVisibilityConfig.ps1 | 12 +- .../Add-VSWAFv2RuleGroupXssMatchStatement.ps1 | 10 +- .../Add-VSWAFv2WebACLAndStatementOne.ps1 | 6 +- .../Add-VSWAFv2WebACLAndStatementTwo.ps1 | 6 +- .../Add-VSWAFv2WebACLByteMatchStatement.ps1 | 32 ++- .../Add-VSWAFv2WebACLDefaultAction.ps1 | 10 +- .../Add-VSWAFv2WebACLExcludedRule.ps1 | 8 +- .../Add-VSWAFv2WebACLFieldToMatch.ps1 | 21 +- .../Add-VSWAFv2WebACLGeoMatchStatement.ps1 | 8 +- ...d-VSWAFv2WebACLIPSetReferenceStatement.ps1 | 10 +- ...VSWAFv2WebACLManagedRuleGroupStatement.ps1 | 14 +- .../Add-VSWAFv2WebACLNotStatementOne.ps1 | 6 +- .../Add-VSWAFv2WebACLNotStatementTwo.ps1 | 6 +- .../Add-VSWAFv2WebACLOrStatementOne.ps1 | 6 +- .../Add-VSWAFv2WebACLOrStatementTwo.ps1 | 6 +- .../Add-VSWAFv2WebACLOverrideAction.ps1 | 10 +- ...Add-VSWAFv2WebACLRateBasedStatementOne.ps1 | 12 +- ...Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 | 10 +- ...ebACLRegexPatternSetReferenceStatement.ps1 | 14 +- .../Add-VSWAFv2WebACLRule.ps1 | 18 +- .../Add-VSWAFv2WebACLRuleAction.ps1 | 12 +- ...WAFv2WebACLRuleGroupReferenceStatement.ps1 | 12 +- ...d-VSWAFv2WebACLSizeConstraintStatement.ps1 | 18 +- .../Add-VSWAFv2WebACLSqliMatchStatement.ps1 | 10 +- .../Add-VSWAFv2WebACLStatementOne.ps1 | 34 ++- .../Add-VSWAFv2WebACLStatementThree.ps1 | 24 +- .../Add-VSWAFv2WebACLStatementTwo.ps1 | 34 ++- .../Add-VSWAFv2WebACLTextTransformation.ps1 | 40 ++- .../Add-VSWAFv2WebACLVisibilityConfig.ps1 | 12 +- .../Add-VSWAFv2WebACLXssMatchStatement.ps1 | 10 +- ...WorkSpacesWorkspaceWorkspaceProperties.ps1 | 2 +- .../New-VSACMPCACertificate.ps1 | 15 +- .../New-VSACMPCACertificateAuthority.ps1 | 31 ++- ...VSACMPCACertificateAuthorityActivation.ps1 | 12 +- .../New-VSAccessAnalyzerAnalyzer.ps1 | 22 +- .../Resource Types/New-VSAlexaASKSkill.ps1 | 3 + .../Resource Types/New-VSAmazonMQBroker.ps1 | 4 +- .../Resource Types/New-VSAmplifyApp.ps1 | 10 +- .../Resource Types/New-VSAmplifyBranch.ps1 | 19 +- .../Resource Types/New-VSApiGatewayApiKey.ps1 | 16 +- .../New-VSApiGatewayClientCertificate.ps1 | 12 +- .../New-VSApiGatewayDomainName.ps1 | 15 +- .../Resource Types/New-VSApiGatewayMethod.ps1 | 4 +- .../New-VSApiGatewayRestApi.ps1 | 16 +- .../Resource Types/New-VSApiGatewayStage.ps1 | 12 +- .../New-VSApiGatewayUsagePlan.ps1 | 12 +- .../Resource Types/New-VSApiGatewayV2Api.ps1 | 32 +-- .../New-VSApiGatewayV2ApiMapping.ps1 | 4 +- .../New-VSApiGatewayV2Authorizer.ps1 | 17 +- .../New-VSApiGatewayV2Deployment.ps1 | 4 +- .../New-VSApiGatewayV2DomainName.ps1 | 2 +- .../New-VSApiGatewayV2Integration.ps1 | 24 +- .../New-VSApiGatewayV2IntegrationResponse.ps1 | 8 +- .../New-VSApiGatewayV2Route.ps1 | 18 +- .../New-VSApiGatewayV2RouteResponse.ps1 | 2 +- .../New-VSApiGatewayV2Stage.ps1 | 14 +- .../New-VSAppConfigApplication.ps1 | 24 +- .../New-VSAppConfigConfigurationProfile.ps1 | 38 ++- .../New-VSAppConfigDeployment.ps1 | 34 ++- .../New-VSAppConfigDeploymentStrategy.ps1 | 40 ++- .../New-VSAppConfigEnvironment.ps1 | 28 +- .../Resource Types/New-VSAppMeshMesh.ps1 | 10 +- .../Resource Types/New-VSAppMeshRoute.ps1 | 10 +- .../New-VSAppMeshVirtualNode.ps1 | 12 +- .../New-VSAppMeshVirtualRouter.ps1 | 10 +- .../New-VSAppMeshVirtualService.ps1 | 10 +- .../Resource Types/New-VSAppStreamFleet.ps1 | 16 +- .../New-VSAppStreamImageBuilder.ps1 | 40 ++- .../Resource Types/New-VSAppStreamStack.ps1 | 14 +- .../Resource Types/New-VSAppSyncApiCache.ps1 | 26 +- .../New-VSAppSyncGraphQLApi.ps1 | 2 +- .../Resource Types/New-VSAppSyncResolver.ps1 | 4 +- ...VSApplicationAutoScalingScalableTarget.ps1 | 6 +- ...-VSApplicationAutoScalingScalingPolicy.ps1 | 6 +- .../New-VSAutoScalingAutoScalingGroup.ps1 | 2 +- .../New-VSAutoScalingScalingPolicy.ps1 | 3 +- .../New-VSCertificateManagerCertificate.ps1 | 10 +- .../New-VSCloud9EnvironmentEC2.ps1 | 12 +- .../New-VSCloudFormationStack.ps1 | 10 +- ...oudFrontCloudFrontOriginAccessIdentity.ps1 | 4 +- .../New-VSCloudFrontDistribution.ps1 | 14 +- .../New-VSCloudFrontStreamingDistribution.ps1 | 14 +- .../Resource Types/New-VSCloudTrailTrail.ps1 | 14 +- .../Resource Types/New-VSCloudWatchAlarm.ps1 | 5 +- .../New-VSCloudWatchCompositeAlarm.ps1 | 237 +++++++++++++++++ .../New-VSCloudWatchDashboard.ps1 | 2 +- .../New-VSCloudWatchInsightRule.ps1 | 10 +- .../Resource Types/New-VSCodeBuildProject.ps1 | 14 +- .../New-VSCodeBuildReportGroup.ps1 | 10 +- .../New-VSCodeBuildSourceCredential.ps1 | 4 +- .../New-VSCodeCommitRepository.ps1 | 14 +- .../New-VSCodeDeployDeploymentGroup.ps1 | 2 +- .../New-VSCodePipelineCustomActionType.ps1 | 13 +- .../New-VSCodePipelinePipeline.ps1 | 19 +- .../New-VSCodePipelineWebhook.ps1 | 12 +- ...SCodeStarNotificationsNotificationRule.ps1 | 18 +- .../New-VSCognitoIdentityPool.ps1 | 16 +- ...ew-VSCognitoIdentityPoolRoleAttachment.ps1 | 5 +- .../Resource Types/New-VSCognitoUserPool.ps1 | 28 +- .../New-VSCognitoUserPoolClient.ps1 | 25 +- .../New-VSCognitoUserPoolDomain.ps1 | 11 +- .../New-VSCognitoUserPoolGroup.ps1 | 6 +- .../New-VSCognitoUserPoolIdentityProvider.ps1 | 39 ++- .../New-VSCognitoUserPoolResourceServer.ps1 | 12 +- ...itoUserPoolRiskConfigurationAttachment.ps1 | 16 +- ...gnitoUserPoolUICustomizationAttachment.ps1 | 18 +- .../New-VSCognitoUserPoolUser.ps1 | 14 +- ...VSCognitoUserPoolUserToGroupAttachment.ps1 | 6 +- .../New-VSConfigAggregationAuthorization.ps1 | 10 +- .../New-VSConfigConfigurationAggregator.ps1 | 10 +- .../New-VSConfigConfigurationRecorder.ps1 | 2 +- .../New-VSConfigConformancePack.ps1 | 18 +- ...ew-VSConfigOrganizationConformancePack.ps1 | 18 +- .../New-VSConfigRemediationConfiguration.ps1 | 10 + .../Resource Types/New-VSDAXCluster.ps1 | 8 +- .../New-VSDLMLifecyclePolicy.ps1 | 1 - .../Resource Types/New-VSDMSCertificate.ps1 | 6 +- .../Resource Types/New-VSDMSEndpoint.ps1 | 26 +- .../New-VSDMSEventSubscription.ps1 | 21 +- .../New-VSDMSReplicationInstance.ps1 | 26 +- .../New-VSDMSReplicationSubnetGroup.ps1 | 14 +- .../New-VSDMSReplicationTask.ps1 | 11 +- .../New-VSDirectoryServiceMicrosoftAD.ps1 | 5 +- .../New-VSDirectoryServiceSimpleAD.ps1 | 5 +- .../Resource Types/New-VSDocDBDBCluster.ps1 | 42 ++- .../New-VSDocDBDBClusterParameterGroup.ps1 | 26 +- .../Resource Types/New-VSDocDBDBInstance.ps1 | 22 +- .../New-VSDocDBDBSubnetGroup.ps1 | 22 +- .../Resource Types/New-VSDynamoDBTable.ps1 | 15 +- .../New-VSEC2ClientVpnEndpoint.ps1 | 10 +- .../New-VSEC2ClientVpnRoute.ps1 | 2 + .../New-VSEC2CustomerGateway.ps1 | 10 +- .../Resource Types/New-VSEC2DHCPOptions.ps1 | 10 +- .../Resource Types/New-VSEC2EC2Fleet.ps1 | 4 +- .../Public/Resource Types/New-VSEC2EIP.ps1 | 15 +- .../Resource Types/New-VSEC2FlowLog.ps1 | 2 +- .../New-VSEC2GatewayRouteTableAssociation.ps1 | 8 +- .../Public/Resource Types/New-VSEC2Host.ps1 | 3 +- .../Resource Types/New-VSEC2Instance.ps1 | 20 +- .../New-VSEC2InternetGateway.ps1 | 10 +- .../New-VSEC2LocalGatewayRoute.ps1 | 10 +- ...C2LocalGatewayRouteTableVPCAssociation.ps1 | 10 +- .../Resource Types/New-VSEC2NatGateway.ps1 | 10 +- .../Resource Types/New-VSEC2NetworkAcl.ps1 | 10 +- .../New-VSEC2NetworkAclEntry.ps1 | 2 + .../New-VSEC2NetworkInterface.ps1 | 12 +- .../Public/Resource Types/New-VSEC2Route.ps1 | 8 +- .../Resource Types/New-VSEC2RouteTable.ps1 | 10 +- .../Resource Types/New-VSEC2SecurityGroup.ps1 | 14 +- .../New-VSEC2SecurityGroupIngress.ps1 | 22 +- .../Public/Resource Types/New-VSEC2Subnet.ps1 | 18 +- .../New-VSEC2SubnetRouteTableAssociation.ps1 | 4 +- .../New-VSEC2TrafficMirrorFilter.ps1 | 25 +- .../New-VSEC2TrafficMirrorFilterRule.ps1 | 29 +- .../New-VSEC2TrafficMirrorSession.ps1 | 38 ++- .../New-VSEC2TrafficMirrorTarget.ps1 | 28 +- .../New-VSEC2TransitGateway.ps1 | 12 +- .../New-VSEC2TransitGatewayAttachment.ps1 | 10 +- .../New-VSEC2TransitGatewayRouteTable.ps1 | 10 +- ...EC2TransitGatewayRouteTableAssociation.ps1 | 4 + .../Public/Resource Types/New-VSEC2VPC.ps1 | 18 +- .../Resource Types/New-VSEC2VPCCidrBlock.ps1 | 4 +- .../Resource Types/New-VSEC2VPCEndpoint.ps1 | 5 +- .../New-VSEC2VPCGatewayAttachment.ps1 | 4 +- .../New-VSEC2VPCPeeringConnection.ps1 | 11 +- .../Resource Types/New-VSEC2VPNConnection.ps1 | 20 +- .../Resource Types/New-VSEC2VPNGateway.ps1 | 10 +- .../Public/Resource Types/New-VSEC2Volume.ps1 | 18 +- .../New-VSEC2VolumeAttachment.ps1 | 4 +- .../Resource Types/New-VSECRRepository.ps1 | 12 +- .../Resource Types/New-VSECSCluster.ps1 | 22 +- .../New-VSECSPrimaryTaskSet.ps1 | 10 +- .../Resource Types/New-VSECSService.ps1 | 34 ++- .../New-VSECSTaskDefinition.ps1 | 17 +- .../Resource Types/New-VSECSTaskSet.ps1 | 25 +- .../Resource Types/New-VSEFSFileSystem.ps1 | 2 +- .../Resource Types/New-VSEKSNodegroup.ps1 | 37 ++- .../Resource Types/New-VSEMRCluster.ps1 | 15 +- .../New-VSEMRInstanceGroupConfig.ps1 | 3 +- .../Public/Resource Types/New-VSEMRStep.ps1 | 2 +- .../New-VSElastiCacheCacheCluster.ps1 | 10 +- .../New-VSElastiCacheReplicationGroup.ps1 | 14 +- ...SElasticBeanstalkConfigurationTemplate.ps1 | 4 + .../New-VSElasticBeanstalkEnvironment.ps1 | 10 +- ...New-VSElasticLoadBalancingLoadBalancer.ps1 | 10 +- .../New-VSElasticLoadBalancingV2Listener.ps1 | 15 +- ...w-VSElasticLoadBalancingV2ListenerRule.ps1 | 1 + ...w-VSElasticLoadBalancingV2LoadBalancer.ps1 | 18 +- ...ew-VSElasticLoadBalancingV2TargetGroup.ps1 | 20 +- .../New-VSElasticsearchDomain.ps1 | 15 +- .../New-VSEventSchemasDiscoverer.ps1 | 10 +- .../New-VSEventSchemasRegistry.ps1 | 10 +- .../New-VSEventSchemasSchema.ps1 | 16 +- .../Resource Types/New-VSEventsEventBus.ps1 | 13 +- .../New-VSEventsEventBusPolicy.ps1 | 6 +- .../Resource Types/New-VSEventsRule.ps1 | 21 +- .../New-VSFMSNotificationChannel.ps1 | 8 +- .../Public/Resource Types/New-VSFMSPolicy.ps1 | 48 +++- .../Resource Types/New-VSFSxFileSystem.ps1 | 29 +- .../Resource Types/New-VSGameLiftAlias.ps1 | 8 +- .../Resource Types/New-VSGameLiftBuild.ps1 | 12 +- .../Resource Types/New-VSGameLiftFleet.ps1 | 49 ++-- .../New-VSGameLiftGameSessionQueue.ps1 | 12 +- ...New-VSGameLiftMatchmakingConfiguration.ps1 | 30 ++- .../New-VSGameLiftMatchmakingRuleSet.ps1 | 8 +- .../Resource Types/New-VSGameLiftScript.ps1 | 10 +- .../Resource Types/New-VSGlueCrawler.ps1 | 2 +- .../Resource Types/New-VSGlueDevEndpoint.ps1 | 23 +- .../Public/Resource Types/New-VSGlueJob.ps1 | 4 + .../Resource Types/New-VSGlueMLTransform.ps1 | 9 +- .../Resource Types/New-VSGlueTrigger.ps1 | 6 +- .../Resource Types/New-VSGlueWorkflow.ps1 | 12 +- .../New-VSGroundStationConfig.ps1 | 195 ++++++++++++++ ...w-VSGroundStationDataflowEndpointGroup.ps1 | 169 ++++++++++++ .../New-VSGroundStationMissionProfile.ps1 | 249 ++++++++++++++++++ .../New-VSGuardDutyDetector.ps1 | 2 +- .../New-VSIAMInstanceProfile.ps1 | 2 +- .../Public/Resource Types/New-VSIAMPolicy.ps1 | 2 +- .../Public/Resource Types/New-VSIAMRole.ps1 | 12 +- .../Public/Resource Types/New-VSIAMUser.ps1 | 13 +- .../New-VSInspectorAssessmentTemplate.ps1 | 10 +- .../New-VSInspectorResourceGroup.ps1 | 10 +- .../New-VSIoTAnalyticsChannel.ps1 | 10 +- .../New-VSIoTAnalyticsDataset.ps1 | 20 +- .../New-VSIoTAnalyticsDatastore.ps1 | 12 +- .../New-VSIoTAnalyticsPipeline.ps1 | 10 +- .../Resource Types/New-VSIoTCertificate.ps1 | 5 +- .../New-VSIoTEventsDetectorModel.ps1 | 14 +- .../Resource Types/New-VSIoTEventsInput.ps1 | 10 +- .../Public/Resource Types/New-VSKMSKey.ps1 | 23 +- .../New-VSKinesisAnalyticsV2Application.ps1 | 2 +- .../Resource Types/New-VSKinesisStream.ps1 | 12 +- .../Resource Types/New-VSLambdaAlias.ps1 | 2 + .../New-VSLambdaEventInvokeConfig.ps1 | 27 +- .../New-VSLambdaEventSourceMapping.ps1 | 16 +- .../Resource Types/New-VSLambdaFunction.ps1 | 14 +- .../Resource Types/New-VSLambdaPermission.ps1 | 2 +- .../Resource Types/New-VSLambdaVersion.ps1 | 6 +- .../Resource Types/New-VSLogsMetricFilter.ps1 | 2 +- .../Resource Types/New-VSMSKCluster.ps1 | 9 +- .../New-VSMediaConvertJobTemplate.ps1 | 44 +++- .../New-VSMediaConvertPreset.ps1 | 20 +- .../New-VSMediaConvertQueue.ps1 | 16 +- .../Resource Types/New-VSNeptuneDBCluster.ps1 | 20 +- .../New-VSNeptuneDBClusterParameterGroup.ps1 | 10 +- .../New-VSNeptuneDBInstance.ps1 | 10 +- .../New-VSNeptuneDBParameterGroup.ps1 | 10 +- .../New-VSNeptuneDBSubnetGroup.ps1 | 10 +- .../Resource Types/New-VSOpsWorksCMServer.ps1 | 30 ++- .../Resource Types/New-VSOpsWorksLayer.ps1 | 10 +- .../Resource Types/New-VSOpsWorksStack.ps1 | 10 +- .../New-VSPinpointADMChannel.ps1 | 8 +- .../New-VSPinpointAPNSChannel.ps1 | 16 +- .../New-VSPinpointAPNSSandboxChannel.ps1 | 20 +- .../New-VSPinpointAPNSVoipChannel.ps1 | 20 +- .../New-VSPinpointAPNSVoipSandboxChannel.ps1 | 12 +- .../Resource Types/New-VSPinpointApp.ps1 | 10 +- .../New-VSPinpointApplicationSettings.ps1 | 24 +- .../New-VSPinpointBaiduChannel.ps1 | 8 +- .../Resource Types/New-VSPinpointCampaign.ps1 | 14 +- .../New-VSPinpointEmailChannel.ps1 | 10 +- .../New-VSPinpointEmailTemplate.ps1 | 18 +- .../New-VSPinpointEventStream.ps1 | 10 +- .../New-VSPinpointGCMChannel.ps1 | 8 +- .../New-VSPinpointPushTemplate.ps1 | 22 +- .../New-VSPinpointSMSChannel.ps1 | 12 +- .../Resource Types/New-VSPinpointSegment.ps1 | 10 +- .../New-VSPinpointSmsTemplate.ps1 | 14 +- .../New-VSPinpointVoiceChannel.ps1 | 8 +- .../Resource Types/New-VSQLDBLedger.ps1 | 26 +- .../Resource Types/New-VSRAMResourceShare.ps1 | 10 +- .../Resource Types/New-VSRDSDBCluster.ps1 | 24 +- .../New-VSRDSDBClusterParameterGroup.ps1 | 19 +- .../Resource Types/New-VSRDSDBInstance.ps1 | 111 ++++---- .../New-VSRDSDBParameterGroup.ps1 | 21 +- .../New-VSRDSDBSecurityGroup.ps1 | 12 +- .../New-VSRDSDBSecurityGroupIngress.ps1 | 8 +- .../Resource Types/New-VSRDSDBSubnetGroup.ps1 | 18 +- .../New-VSRDSEventSubscription.ps1 | 12 +- .../Resource Types/New-VSRDSOptionGroup.ps1 | 10 +- .../Resource Types/New-VSRedshiftCluster.ps1 | 14 +- .../New-VSRedshiftClusterParameterGroup.ps1 | 10 +- .../New-VSRedshiftClusterSecurityGroup.ps1 | 10 +- .../New-VSRedshiftClusterSubnetGroup.ps1 | 10 +- .../New-VSRoboMakerRobotApplication.ps1 | 2 +- .../New-VSRoboMakerSimulationApplication.ps1 | 2 +- .../New-VSRoute53HealthCheck.ps1 | 4 +- .../New-VSRoute53HostedZone.ps1 | 21 +- .../Resource Types/New-VSRoute53RecordSet.ps1 | 43 +-- .../New-VSRoute53RecordSetGroup.ps1 | 13 +- .../New-VSRoute53ResolverResolverEndpoint.ps1 | 24 +- .../New-VSRoute53ResolverResolverRule.ps1 | 22 +- ...Route53ResolverResolverRuleAssociation.ps1 | 10 +- .../Resource Types/New-VSS3AccessPoint.ps1 | 20 +- .../Public/Resource Types/New-VSS3Bucket.ps1 | 20 +- .../Resource Types/New-VSS3BucketPolicy.ps1 | 22 +- ...-VSSESConfigurationSetEventDestination.ps1 | 10 +- .../Resource Types/New-VSSNSSubscription.ps1 | 6 +- .../Public/Resource Types/New-VSSNSTopic.ps1 | 15 +- .../Public/Resource Types/New-VSSQSQueue.ps1 | 12 +- .../Resource Types/New-VSSSMAssociation.ps1 | 7 +- .../Resource Types/New-VSSSMDocument.ps1 | 25 +- .../New-VSSSMMaintenanceWindow.ps1 | 10 +- .../New-VSSSMMaintenanceWindowTarget.ps1 | 9 +- .../New-VSSSMMaintenanceWindowTask.ps1 | 4 +- .../Resource Types/New-VSSSMParameter.ps1 | 8 +- .../Resource Types/New-VSSSMPatchBaseline.ps1 | 10 +- .../New-VSSSMResourceDataSync.ps1 | 22 +- .../New-VSSageMakerEndpoint.ps1 | 14 +- .../New-VSSageMakerEndpointConfig.ps1 | 23 +- .../Resource Types/New-VSSageMakerModel.ps1 | 10 +- .../New-VSSageMakerNotebookInstance.ps1 | 10 +- .../New-VSSageMakerWorkteam.ps1 | 10 +- .../New-VSSecretsManagerResourcePolicy.ps1 | 10 +- .../New-VSSecretsManagerRotationSchedule.ps1 | 10 +- .../New-VSSecretsManagerSecret.ps1 | 30 +-- ...VSSecretsManagerSecretTargetAttachment.ps1 | 19 +- ...-VSServiceCatalogCloudFormationProduct.ps1 | 10 +- ...atalogCloudFormationProvisionedProduct.ps1 | 10 +- .../New-VSServiceCatalogPortfolio.ps1 | 10 +- .../New-VSServiceDiscoveryService.ps1 | 3 +- .../New-VSStepFunctionsActivity.ps1 | 1 + .../New-VSStepFunctionsStateMachine.ps1 | 6 + .../Resource Types/New-VSTransferServer.ps1 | 19 +- .../Resource Types/New-VSTransferUser.ps1 | 24 +- .../Public/Resource Types/New-VSWAFIPSet.ps1 | 12 +- .../New-VSWAFRegionalGeoMatchSet.ps1 | 10 +- .../Resource Types/New-VSWAFRegionalIPSet.ps1 | 12 +- .../New-VSWAFRegionalRateBasedRule.ps1 | 2 + .../New-VSWAFRegionalRegexPatternSet.ps1 | 2 + .../New-VSWAFRegionalSizeConstraintSet.ps1 | 10 +- .../New-VSWAFRegionalSqlInjectionMatchSet.ps1 | 10 +- .../New-VSWAFRegionalXssMatchSet.ps1 | 10 +- .../New-VSWAFSizeConstraintSet.ps1 | 10 +- .../New-VSWAFSqlInjectionMatchSet.ps1 | 10 +- .../Resource Types/New-VSWAFXssMatchSet.ps1 | 10 +- .../Resource Types/New-VSWAFv2IPSet.ps1 | 38 ++- .../New-VSWAFv2RegexPatternSet.ps1 | 30 ++- .../Resource Types/New-VSWAFv2RuleGroup.ps1 | 36 ++- .../Resource Types/New-VSWAFv2WebACL.ps1 | 32 ++- .../New-VSWAFv2WebACLAssociation.ps1 | 17 +- .../New-VSWorkSpacesWorkspace.ps1 | 14 +- VaporShell/bin/TransformTag.cs | 77 ------ ci/Convert-SpecToFunction.ps1 | 15 +- ci/aws-cloudformation-user-guide | 2 +- invoke.build.ps1 | 7 + 850 files changed, 7463 insertions(+), 3426 deletions(-) create mode 100644 Add-FnCidr.ps1 create mode 100644 Add-FnTransform.ps1 create mode 100644 VaporShell.Core/VaporShell.Core.cs create mode 100644 VaporShell.Core/VaporShell.Core.csproj create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackendDefaults.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicy.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicyTls.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTls.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsAcmCertificate.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsCertificate.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsFileCertificate.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContext.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextAcmTrust.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextFileTrust.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextTrust.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDownloadOwnerSetting.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDownloadOwnerSetting.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupDataflowEndpoint.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupEndpointDetails.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSecurityDetails.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSocketAddress.ps1 create mode 100644 VaporShell/Public/Resource Property Types/Add-VSGroundStationMissionProfileDataflowEdge.ps1 create mode 100644 VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 create mode 100644 VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 create mode 100644 VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 create mode 100644 VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 delete mode 100644 VaporShell/bin/TransformTag.cs diff --git a/Add-FnCidr.ps1 b/Add-FnCidr.ps1 new file mode 100644 index 000000000..7cab57115 --- /dev/null +++ b/Add-FnCidr.ps1 @@ -0,0 +1,77 @@ +function Add-FnCidr { + <# + .SYNOPSIS + Adds the intrinsic function "Fn::Cidr" to a resource property + + .DESCRIPTION + The intrinsic function Fn::Cidr returns an array of CIDR address blocks. The number of CIDR blocks returned is dependent on the count parameter. + + .LINK + https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-cidr.html + + .PARAMETER IpBlock + The user-specified CIDR address block to be split into smaller CIDR blocks. + + .PARAMETER Count + The number of CIDRs to generate. Valid range is between 1 and 256. + + .PARAMETER CidrBits + The number of subnet bits for the CIDR. For example, specifying a value "8" for this parameter will create a CIDR with a mask of "/24". + + .EXAMPLE + Add-FnCidr -IpBlock "192.168.0.0/24" -Count 6 -CidrBits 5 + + When the template is exported, this will convert to: { "Fn::Cidr" : [ "192.168.0.0/24", "6", "5"] } + + .NOTES + You can use the following functions in a Fn::Cidr function: + Fn::Select + Ref + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Function.Cidr')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true,Position = 0)] + [ValidateScript({ + $allowedTypes = "Vaporshell.Function.Select","Vaporshell.Function.Ref","System.String" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $IpBlock, + [parameter(Mandatory = $true,Position = 1)] + [ValidateScript({ + $allowedTypes = "Vaporshell.Function.Select","Vaporshell.Function.Ref","System.String","System.Int32" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Count, + [parameter(Mandatory = $true,Position = 2)] + [ValidateScript({ + $allowedTypes = "Vaporshell.Function.FindInMap","Vaporshell.Function.Ref","System.String" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $CidrBits + ) + $obj = [PSCustomObject][Ordered]@{ + "Fn::Cidr" = @($IpBlock,$Count,$CidrBits) + } + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Function','Vaporshell.Function.Cidr' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n`t$($obj | ConvertTo-Json -Depth 5 -Compress)`n" +} diff --git a/Add-FnTransform.ps1 b/Add-FnTransform.ps1 new file mode 100644 index 000000000..967a7211d --- /dev/null +++ b/Add-FnTransform.ps1 @@ -0,0 +1,60 @@ +function Add-FnTransform { + <# + .SYNOPSIS + Adds the intrinsic function "Fn::Transform" to a resource property + + .DESCRIPTION + The intrinsic function Fn::Transform specifies a macro to perform custom processing on part of a stack template. Macros enable you to perform custom processing on templates, from simple actions like find-and-replace operations to extensive transformations of entire templates. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. + + You can also use Fn::Transform to call the AWS::Include Transform transform, which is a macro hosted by AWS CloudFormation. + + .LINK + https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-transform.html + + .PARAMETER Name + The name of the macro you want to perform the processing. + + .PARAMETER Parameters + The list parameters, specified as a hashtable, to pass to the macro. + + .EXAMPLE + Add-FnTransform -Name "AWS::Include" -Parameters @{Location = (Add-FnRef "InputValue")} + + This example calls the AWS::Include transform, specifying that the location to retrieve a template snippet from is passed in the InputValue parameter. + + When the template is exported, this will convert to: + { + "Fn::Transform" : { + "Name" : "AWS::Include", + "Parameters" : { + "Location" : { "Ref" : "InputValue" } + } + } + } + + .NOTES + AWS CloudFormation passes any intrinsic function calls included in Fn::Transform to the specified macro as literal strings. For more information, see AWS CloudFormation Macro Function Interface. + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Function.Transform')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true,Position = 0)] + [String] + $Name, + [parameter(Mandatory = $true,Position = 1)] + [Hashtable] + $Parameters + ) + $obj = [PSCustomObject][Ordered]@{ + "Fn::Transform" = @{ + Name = $Name + Parameters = $Parameters + } + } + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Function','Vaporshell.Function.Transform' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n`t$($obj | ConvertTo-Json -Depth 5 -Compress)`n" +} diff --git a/VaporShell.Core/VaporShell.Core.cs b/VaporShell.Core/VaporShell.Core.cs new file mode 100644 index 000000000..1cd96bd78 --- /dev/null +++ b/VaporShell.Core/VaporShell.Core.cs @@ -0,0 +1,120 @@ +using System; +using System.Collections; +using System.Collections.Generic; +using System.Management.Automation; + +namespace VaporShell.Core +{ + public class TransformTagAttribute : ArgumentTransformationAttribute + { + private EngineIntrinsics engineIntrinsics; + + private IEnumerable ConvertToTag(object key, object value) + { + PSObject tag = new PSObject(); + tag.Members.Add(new PSNoteProperty("Key", key)); + tag.Members.Add(new PSNoteProperty("Value", value)); + tag.TypeNames.Insert(0,"Vaporshell.Resource.Tag"); + + yield return tag; + } + + private IEnumerable TransformHashtable(IDictionary inputData) + { + if (inputData.Contains("Key") && inputData.Contains("Value")) + { + foreach (PSObject tag in this.ConvertToTag(inputData["Key"],inputData["Value"])) + { + yield return tag; + } + } + else + { + foreach (string key in inputData.Keys) + { + foreach (PSObject tag in this.ConvertToTag(key,inputData[key])) + { + yield return tag; + } + } + } + } + + private IEnumerable TransformPSObject(PSObject inputData) + { + var props = new List(); + foreach (var property in inputData.Properties) + { + props.Add(property.Name); + } + if (props.Contains("Key") && props.Contains("Value")) + { + object key = null; + object value = null; + + foreach (var property in inputData.Properties) + { + if (property.Name == "Key") + { + key = property.Value; + } + else if (property.Name == "Value") + { + value = property.Value; + } + } + foreach (PSObject tag in this.ConvertToTag(key,value)) + { + yield return tag; + } + } + else + { + foreach (var property in inputData.Properties) + { + foreach (PSObject tag in this.ConvertToTag(property.Name,property.Value)) + { + yield return tag; + } + } + } + } + + private object TransformData(object inputData) + { + if (inputData is Array) + { + var formatted = new List(); + foreach (object item in inputData as object[]) + { + formatted.Add((this.TransformData(item) as PSObject)); + } + return formatted; + } + else if (inputData is IDictionary) + { + return this.TransformHashtable(inputData as IDictionary); + } + else if (inputData is PSObject) + { + PSObject psObject = inputData as PSObject; + if (psObject.TypeNames.Contains("Vaporshell.Resource.Tag")) + { + return inputData; + } + else if (psObject.TypeNames.Contains("System.Management.Automation.PSCustomObject")) + { + return this.TransformPSObject(psObject); + } + } + + return inputData; + } + + public override object Transform(EngineIntrinsics engineIntrinsics, object inputData) + { + this.engineIntrinsics = engineIntrinsics; + return this.TransformData(inputData); + } + } +} diff --git a/VaporShell.Core/VaporShell.Core.csproj b/VaporShell.Core/VaporShell.Core.csproj new file mode 100644 index 000000000..2d9368eee --- /dev/null +++ b/VaporShell.Core/VaporShell.Core.csproj @@ -0,0 +1,10 @@ + + + + netstandard2.0 + + + + + + diff --git a/VaporShell/Private/PseudoParams.txt b/VaporShell/Private/PseudoParams.txt index e9c9a90d6..bece4ea60 100644 --- a/VaporShell/Private/PseudoParams.txt +++ b/VaporShell/Private/PseudoParams.txt @@ -4,4 +4,6 @@ AWS::NoValue AWS::NotificationARNs AWS::Region AWS::StackName -AWS::Include \ No newline at end of file +AWS::Include +AWS::Partition +AWS::URLSuffix \ No newline at end of file diff --git a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityCrlConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityCrlConfiguration.ps1 index c954834a5..1bc820178 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityCrlConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityCrlConfiguration.ps1 @@ -1,31 +1,77 @@ function Add-VSACMPCACertificateAuthorityCrlConfiguration { <# .SYNOPSIS - Adds an AWS::ACMPCA::CertificateAuthority.CrlConfiguration resource property to the template. + Adds an AWS::ACMPCA::CertificateAuthority.CrlConfiguration resource property to the template. Contains configuration information for a certificate revocation list (CRL. Your private certificate authority (CA creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the **Enabled** parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the **S3BucketName** parameter. You can hide the name of your bucket by specifying a value for the **CustomCname** parameter. Your private CA copies the CNAME or the S3 bucket name to the **CRL Distribution Points** extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA. .DESCRIPTION Adds an AWS::ACMPCA::CertificateAuthority.CrlConfiguration resource property to the template. +Contains configuration information for a certificate revocation list (CRL. Your private certificate authority (CA creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the **Enabled** parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the **S3BucketName** parameter. You can hide the name of your bucket by specifying a value for the **CustomCname** parameter. Your private CA copies the CNAME or the S3 bucket name to the **CRL Distribution Points** extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA. +Your private CA uses the value in the **ExpirationInDays** parameter to calculate the **nextUpdate** field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. + +CRLs contain the following fields: + ++ **Version**: The current version number defined in RFC 5280 is V2. The integer value is 0x1. + ++ **Signature Algorithm**: The name of the algorithm used to sign the CRL. + ++ **Issuer**: The X.500 distinguished name of your private CA that issued the CRL. + ++ **Last Update**: The issue date and time of this CRL. + ++ **Next Update**: The day and time by which the next CRL will be issued. + ++ **Revoked Certificates**: List of revoked certificates. Each list item contains the following information. + ++ **Serial Number**: The serial number, in hexadecimal format, of the revoked certificate. + ++ **Revocation Date**: Date and time the certificate was revoked. + ++ **CRL Entry Extensions**: Optional extensions for the CRL entry. + ++ **X509v3 CRL Reason Code**: Reason the certificate was revoked. + ++ **CRL Extensions**: Optional extensions for the CRL. + ++ **X509v3 Authority Key Identifier**: Identifies the public key associated with the private key used to sign the certificate. + ++ **X509v3 CRL Number:**: Decimal sequence number for the CRL. + ++ **Signature Algorithm**: Algorithm used by your private CA to sign the CRL. + ++ **Signature Value**: Signature computed over the CRL. + +Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL. + +openssl crl -inform DER -text -in crl_path -noout .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html .PARAMETER Enabled + Boolean value that specifies whether certificate revocation lists CRLs are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html action or for an existing CA when you call the UpdateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER ExpirationInDays + Number of days until a certificate expires. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-expirationindays UpdateType: Mutable PrimitiveType: Integer .PARAMETER CustomCname + Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-customcname UpdateType: Mutable PrimitiveType: String .PARAMETER S3BucketName + Name of the S3 bucket that contains the CRL. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3bucketname UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityRevocationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityRevocationConfiguration.ps1 index 88cea1604..35be05b7a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityRevocationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthorityRevocationConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSACMPCACertificateAuthorityRevocationConfiguration { <# .SYNOPSIS - Adds an AWS::ACMPCA::CertificateAuthority.RevocationConfiguration resource property to the template. + Adds an AWS::ACMPCA::CertificateAuthority.RevocationConfiguration resource property to the template. Certificate revocation information used by the CreateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html and UpdateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html actions. Your private certificate authority (CA can create and maintain a certificate revocation list (CRL. A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html. .DESCRIPTION Adds an AWS::ACMPCA::CertificateAuthority.RevocationConfiguration resource property to the template. - +Certificate revocation information used by the CreateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html and UpdateCertificateAuthority: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html actions. Your private certificate authority (CA can create and maintain a certificate revocation list (CRL. A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html .PARAMETER CrlConfiguration + Configuration of the certificate revocation list CRL, if any, maintained by your private CA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-crlconfiguration UpdateType: Mutable Type: CrlConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthoritySubject.ps1 b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthoritySubject.ps1 index d6ec96ba4..7d74d11c0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthoritySubject.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateAuthoritySubject.ps1 @@ -1,81 +1,109 @@ function Add-VSACMPCACertificateAuthoritySubject { <# .SYNOPSIS - Adds an AWS::ACMPCA::CertificateAuthority.Subject resource property to the template. + Adds an AWS::ACMPCA::CertificateAuthority.Subject resource property to the template. ASN1 subject for the certificate authority. .DESCRIPTION Adds an AWS::ACMPCA::CertificateAuthority.Subject resource property to the template. - +ASN1 subject for the certificate authority. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html .PARAMETER Country + Two-digit code that specifies the country in which the certificate subject located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-country UpdateType: Immutable PrimitiveType: String .PARAMETER Organization + Legal name of the organization with which the certificate subject is affiliated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-organization UpdateType: Immutable PrimitiveType: String .PARAMETER OrganizationalUnit + A subdivision or unit of the organization such as sales or finance with which the certificate subject is affiliated. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-organizationalunit UpdateType: Immutable PrimitiveType: String .PARAMETER DistinguishedNameQualifier + Disambiguating information for the certificate subject. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-distinguishednamequalifier UpdateType: Immutable PrimitiveType: String .PARAMETER State + State in which the subject of the certificate is located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-state UpdateType: Immutable PrimitiveType: String .PARAMETER CommonName + Fully qualified domain name FQDN associated with the certificate subject. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-commonname UpdateType: Immutable PrimitiveType: String .PARAMETER SerialNumber + The certificate serial number. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-serialnumber UpdateType: Immutable PrimitiveType: String .PARAMETER Locality + The locality such as a city or town in which the certificate subject is located. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-locality UpdateType: Immutable PrimitiveType: String .PARAMETER Title + A personal title such as Mr. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-title UpdateType: Immutable PrimitiveType: String .PARAMETER Surname + Family name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-surname UpdateType: Immutable PrimitiveType: String .PARAMETER GivenName + First name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-givenname UpdateType: Immutable PrimitiveType: String .PARAMETER Initials + Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-initials UpdateType: Immutable PrimitiveType: String .PARAMETER Pseudonym + Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-pseudonym UpdateType: Immutable PrimitiveType: String .PARAMETER GenerationQualifier + Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-generationqualifier UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateValidity.ps1 b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateValidity.ps1 index bf3769b17..f700af0fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateValidity.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSACMPCACertificateValidity.ps1 @@ -1,21 +1,35 @@ function Add-VSACMPCACertificateValidity { <# .SYNOPSIS - Adds an AWS::ACMPCA::Certificate.Validity resource property to the template. + Adds an AWS::ACMPCA::Certificate.Validity resource property to the template. The period of time during which a certificate issued by your private certificate authority (CA is valid. The expiration can be absolute (expressed as an explicit date and time or relative (expressed as a period of time after issuance in days, months, or years. For more information, see Validity: https://tools.ietf.org/html/rfc5280#section-4.1.2.5 in RFC 5280. .DESCRIPTION Adds an AWS::ACMPCA::Certificate.Validity resource property to the template. +The period of time during which a certificate issued by your private certificate authority (CA is valid. The expiration can be absolute (expressed as an explicit date and time or relative (expressed as a period of time after issuance in days, months, or years. For more information, see Validity: https://tools.ietf.org/html/rfc5280#section-4.1.2.5 in RFC 5280. +You can issue a certificate by calling the IssueCertificate: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html .PARAMETER Value + Time period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-value UpdateType: Immutable PrimitiveType: Integer .PARAMETER Type + Determines how *ACM Private CA* interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with absolute values include a sample input value and the resulting output. +END_DATE: Absolute value, using UTCTime YYMMDDHHMMSS or GeneralizedTime YYYYMMDDHHMMSS format. ++ Sample input value: 491231235959 UTCTime format ++ Output date: 12/31/2049 23:59:59 +ABSOLUTE: Absolute value, expressed as the number of seconds since the Unix epoch. ++ Sample input value: 2524608000 ++ Output date: 01/01/2050 00:00:00 +DAYS, MONTHS, YEARS: Relative values, setting expiration as a number of days, months, or years after certificate issuance. +Note: When UTCTime is used, if the year field YY is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-type UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerArchiveRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerArchiveRule.ps1 index beb602162..2f0227ce6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerArchiveRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerArchiveRule.ps1 @@ -1,22 +1,26 @@ function Add-VSAccessAnalyzerAnalyzerArchiveRule { <# .SYNOPSIS - Adds an AWS::AccessAnalyzer::Analyzer.ArchiveRule resource property to the template. + Adds an AWS::AccessAnalyzer::Analyzer.ArchiveRule resource property to the template. The criteria for an archive rule. .DESCRIPTION Adds an AWS::AccessAnalyzer::Analyzer.ArchiveRule resource property to the template. - +The criteria for an archive rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html .PARAMETER Filter + The criteria for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html#cfn-accessanalyzer-analyzer-archiverule-filter UpdateType: Mutable Type: List ItemType: Filter .PARAMETER RuleName + The name of the archive rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html#cfn-accessanalyzer-analyzer-archiverule-rulename UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerFilter.ps1 index b92544f36..5fff005b5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAccessAnalyzerAnalyzerFilter.ps1 @@ -1,38 +1,48 @@ function Add-VSAccessAnalyzerAnalyzerFilter { <# .SYNOPSIS - Adds an AWS::AccessAnalyzer::Analyzer.Filter resource property to the template. + Adds an AWS::AccessAnalyzer::Analyzer.Filter resource property to the template. The criteria that defines the rule. .DESCRIPTION Adds an AWS::AccessAnalyzer::Analyzer.Filter resource property to the template. - +The criteria that defines the rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html .PARAMETER Contains + A "contains" condition to match for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-contains UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Eq + An "equals" condition to match for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-eq UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Exists + An "exists" condition to match for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-exists UpdateType: Mutable PrimitiveType: Boolean .PARAMETER Property + The property used to define the criteria in the filter for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-property UpdateType: Mutable PrimitiveType: String .PARAMETER Neq + A "not equal" condition to match for the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-neq UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 index 2b9fbc0ce..34f279c1f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillAuthenticationConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSAlexaASKSkillAuthenticationConfiguration { <# .SYNOPSIS - Adds an Alexa::ASK::Skill.AuthenticationConfiguration resource property to the template. The AuthenticationConfiguration property type specifies the Login with Amazon (LWA configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the Amazon Developer Console: https://developer.amazon.com/lwa/sp/overview.html are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new security profile: https://developer.amazon.com/lwa/sp/create-security-profile.html on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then produce the refresh token by providing the client ID and client secret to the generate-lwa-tokens: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#generate-lwa-tokens command in the ASK CLI: https://developer.amazon.com/docs/smapi/ask-cli-intro.html. + Adds an Alexa::ASK::Skill.AuthenticationConfiguration resource property to the template. The AuthenticationConfiguration property type specifies the Login with Amazon (LWA configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the Build Skills with the Alexa Skills Kit developer documentation: https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new security profile: https://developer.amazon.com/lwa/sp/create-security-profile.html on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then retrieve the refresh token using the Alexa Skills Kit CLI. For instructions, see util-command: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#util-command in the ASK CLI Command Reference: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html. .DESCRIPTION Adds an Alexa::ASK::Skill.AuthenticationConfiguration resource property to the template. -The AuthenticationConfiguration property type specifies the Login with Amazon (LWA configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the Amazon Developer Console: https://developer.amazon.com/lwa/sp/overview.html are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new security profile: https://developer.amazon.com/lwa/sp/create-security-profile.html on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then produce the refresh token by providing the client ID and client secret to the generate-lwa-tokens: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#generate-lwa-tokens command in the ASK CLI: https://developer.amazon.com/docs/smapi/ask-cli-intro.html. +The AuthenticationConfiguration property type specifies the Login with Amazon (LWA configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the Build Skills with the Alexa Skills Kit developer documentation: https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new security profile: https://developer.amazon.com/lwa/sp/create-security-profile.html on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then retrieve the refresh token using the Alexa Skills Kit CLI. For instructions, see util-command: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#util-command in the ASK CLI Command Reference: https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html. AuthenticationConfiguration is a property of the Alexa::ASK::Skill resource. @@ -13,7 +13,7 @@ AuthenticationConfiguration is a property of the Alexa::ASK::Skill resource. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html .PARAMETER RefreshToken - Refresh token from Login with Amazon LWA. + Refresh token from Login with Amazon LWA. This token is secret. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-refreshtoken PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 index ea6ec99a6..71710d551 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAlexaASKSkillSkillPackage.ps1 @@ -13,7 +13,7 @@ SkillPackage is a property of the Alexa::ASK::Skill resource. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html .PARAMETER S3BucketRole - ARN of the role that grants the Alexa service permission to access the bucket and retrieve the skill package. This role is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, AWS CloudFormation cannot create the skill. + ARN of the IAM role that grants the Alexa service alexa-appkit.amazon.com permission to access the bucket and retrieve the skill package. This property is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, AWS CloudFormation cannot create the skill. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucketrole PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 index 377ae2fb0..f008f36ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAmplifyAppAutoBranchCreationConfig.ps1 @@ -26,7 +26,10 @@ Use the AutoBranchCreationConfig property type to automatically create branches UpdateType: Mutable .PARAMETER PullRequestEnvironmentName - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named prod, test, or dev that you initialized with the Amplify CLI. +To enable pull request previews, set the EnablePullRequestPreview property to true. +If you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console deletes this environment when the pull request is closed. +For more information about creating backend environments, see Feature Branch Deployments and Team Workflows: https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html in the *AWS Amplify Console User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-pullrequestenvironmentname PrimitiveType: String @@ -41,7 +44,9 @@ Use the AutoBranchCreationConfig property type to automatically create branches UpdateType: Mutable .PARAMETER EnablePullRequestPreview - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app. Amplify Console creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. +To provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the PullRequestEnvironmentName property. +For more information, see Web Previews: https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html in the *AWS Amplify Console User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enablepullrequestpreview PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 index 61eefc07d..39d3c934c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentAccessLogSetting.ps1 @@ -13,7 +13,7 @@ AccessLogSetting is a property of the StageDescription: https://docs.aws.amazon. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html .PARAMETER DestinationArn - The Amazon Resource Name ARN of the CloudWatch Logs log group to receive access logs. + The Amazon Resource Name ARN of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 index 876573c2f..e7c553199 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayDeploymentStageDescription.ps1 @@ -293,16 +293,8 @@ For more information, see Trace API Gateway API Execution with AWS X-Ray: https: } })] $MetricsEnabled, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 index 5c4997b06..514c6a722 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayMethodIntegration.ps1 @@ -11,7 +11,7 @@ Integration is a property of the AWS::ApiGateway::Method: https://docs.aws.amazo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html .PARAMETER CacheKeyParameters - A list of request parameters whose values API Gateway caches. These parameters must also be specified in RequestParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters to be supported in CacheKeyParameters. + A list of request parameters whose values API Gateway caches. For cases where the integration type allows for RequestParameters to be set, these parameters must also be specified in RequestParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters to be supported in CacheKeyParameters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 index 582e98594..674d7a42b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayRestApiEndpointConfiguration.ps1 @@ -25,7 +25,7 @@ EndpointConfiguration is a property of the AWS::ApiGateway::RestApi: https://doc UpdateType: Mutable .PARAMETER VpcEndpointIds - + RestApi: https://docs.aws.amazon.com/apigateway/api-reference/resource/rest-api/ in the *Amazon API Gateway REST API Reference* + A list of VPC endpoint IDs of an API AWS::ApiGateway::RestApi: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 index f233399c0..22762aaa8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayStageAccessLogSetting.ps1 @@ -13,7 +13,7 @@ AccessLogSetting is a property of the AWS::ApiGateway::Stage: https://docs.aws.a http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html .PARAMETER DestinationArn - The Amazon Resource Name ARN of the CloudWatch Logs log group to receive access logs. + The Amazon Resource Name ARN of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiBodyS3Location.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiBodyS3Location.ps1 index 6cded301b..5be895e70 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiBodyS3Location.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiBodyS3Location.ps1 @@ -1,31 +1,39 @@ function Add-VSApiGatewayV2ApiBodyS3Location { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Api.BodyS3Location resource property to the template. + Adds an AWS::ApiGatewayV2::Api.BodyS3Location resource property to the template. The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs. .DESCRIPTION Adds an AWS::ApiGatewayV2::Api.BodyS3Location resource property to the template. - +The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html .PARAMETER Etag + The Etag of the S3 object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket + The S3 bucket that contains the OpenAPI definition to import. Required if you specify a BodyS3Location for an API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Version + The version of the S3 object. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key of the S3 object. Required if you specify a BodyS3Location for an API. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiCors.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiCors.ps1 index dff796e0d..1013a9e60 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiCors.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2ApiCors.ps1 @@ -1,44 +1,56 @@ function Add-VSApiGatewayV2ApiCors { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Api.Cors resource property to the template. + Adds an AWS::ApiGatewayV2::Api.Cors resource property to the template. The Cors property specifies a CORS configuration for an API. Supported only for HTTP APIs. See Configuring CORS: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html for more information. .DESCRIPTION Adds an AWS::ApiGatewayV2::Api.Cors resource property to the template. - +The Cors property specifies a CORS configuration for an API. Supported only for HTTP APIs. See Configuring CORS: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html for more information. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html .PARAMETER AllowOrigins + Represents a collection of allowed origins. Supported only for HTTP APIs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-alloworigins UpdateType: Mutable .PARAMETER AllowCredentials + Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowcredentials PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExposeHeaders + Represents a collection of exposed headers. Supported only for HTTP APIs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-exposeheaders UpdateType: Mutable .PARAMETER AllowHeaders + Represents a collection of allowed headers. Supported only for HTTP APIs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowheaders UpdateType: Mutable .PARAMETER MaxAge + The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-maxage PrimitiveType: Integer UpdateType: Mutable .PARAMETER AllowMethods + Represents a collection of allowed HTTP methods. Supported only for HTTP APIs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowmethods diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2AuthorizerJWTConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2AuthorizerJWTConfiguration.ps1 index d575bd9b1..1fb40c2f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2AuthorizerJWTConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2AuthorizerJWTConfiguration.ps1 @@ -1,21 +1,25 @@ function Add-VSApiGatewayV2AuthorizerJWTConfiguration { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Authorizer.JWTConfiguration resource property to the template. + Adds an AWS::ApiGatewayV2::Authorizer.JWTConfiguration resource property to the template. The JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. .DESCRIPTION Adds an AWS::ApiGatewayV2::Authorizer.JWTConfiguration resource property to the template. - +The JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html .PARAMETER Issuer + The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-issuer PrimitiveType: String UpdateType: Mutable .PARAMETER Audience + A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519: https://tools.ietf.org/html/rfc7519#section-4.1.3. Supported only for HTTP APIs. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-audience diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 index 5f5890695..40b154e32 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2DomainNameDomainNameConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSApiGatewayV2DomainNameDomainNameConfiguration { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::DomainName.DomainNameConfiguration resource property to the template. The DomainNameConfiguration property type specifies the configuration for a WebSocket's domain name. + Adds an AWS::ApiGatewayV2::DomainName.DomainNameConfiguration resource property to the template. The DomainNameConfiguration property type specifies the configuration for a an API's domain name. .DESCRIPTION Adds an AWS::ApiGatewayV2::DomainName.DomainNameConfiguration resource property to the template. -The DomainNameConfiguration property type specifies the configuration for a WebSocket's domain name. +The DomainNameConfiguration property type specifies the configuration for a an API's domain name. DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html resource. diff --git a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 index 20fa577f4..df8da03f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApiGatewayV2StageRouteSettings.ps1 @@ -11,21 +11,21 @@ Represents a collection of route settings. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html .PARAMETER LoggingLevel - Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs. + Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel PrimitiveType: String UpdateType: Mutable .PARAMETER DataTraceEnabled - Specifies whether true or not false data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. + Specifies whether true or not false data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ThrottlingBurstLimit - Specifies the throttling burst limit. + Specifies the throttling burst limit. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit PrimitiveType: Integer @@ -39,7 +39,7 @@ Represents a collection of route settings. UpdateType: Mutable .PARAMETER ThrottlingRateLimit - Specifies the throttling rate limit. + Specifies the throttling rate limit. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit PrimitiveType: Double diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigApplicationTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigApplicationTags.ps1 index 3befb9eaf..fe47ea9a1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigApplicationTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigApplicationTags.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigApplicationTags { <# .SYNOPSIS - Adds an AWS::AppConfig::Application.Tags resource property to the template. + Adds an AWS::AppConfig::Application.Tags resource property to the template. Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .DESCRIPTION Adds an AWS::AppConfig::Application.Tags resource property to the template. - +Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-application-tags.html .PARAMETER Value + The tag value can be up to 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-application-tags.html#cfn-appconfig-application-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key-value string map. The valid character set is a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-application-tags.html#cfn-appconfig-application-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileTags.ps1 index 39de6fa63..c1c4ce898 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileTags.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigConfigurationProfileTags { <# .SYNOPSIS - Adds an AWS::AppConfig::ConfigurationProfile.Tags resource property to the template. + Adds an AWS::AppConfig::ConfigurationProfile.Tags resource property to the template. Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .DESCRIPTION Adds an AWS::AppConfig::ConfigurationProfile.Tags resource property to the template. - +Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html .PARAMETER Value + The tag value can be up to 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html#cfn-appconfig-configurationprofile-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key-value string map. The valid character set is a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html#cfn-appconfig-configurationprofile-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileValidators.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileValidators.ps1 index 9c82b3c62..e1e06bc45 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileValidators.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigConfigurationProfileValidators.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigConfigurationProfileValidators { <# .SYNOPSIS - Adds an AWS::AppConfig::ConfigurationProfile.Validators resource property to the template. + Adds an AWS::AppConfig::ConfigurationProfile.Validators resource property to the template. A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. .DESCRIPTION Adds an AWS::AppConfig::ConfigurationProfile.Validators resource property to the template. - +A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html .PARAMETER Type + AppConfig supports validators of type JSON_SCHEMA and LAMBDA + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html#cfn-appconfig-configurationprofile-validators-type PrimitiveType: String UpdateType: Mutable .PARAMETER Content + Either the JSON Schema content or the Amazon Resource Name ARN of an AWS Lambda function. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html#cfn-appconfig-configurationprofile-validators-content PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentStrategyTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentStrategyTags.ps1 index 0cf5c72ef..381d2928d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentStrategyTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentStrategyTags.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigDeploymentStrategyTags { <# .SYNOPSIS - Adds an AWS::AppConfig::DeploymentStrategy.Tags resource property to the template. + Adds an AWS::AppConfig::DeploymentStrategy.Tags resource property to the template. Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .DESCRIPTION Adds an AWS::AppConfig::DeploymentStrategy.Tags resource property to the template. - +Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deploymentstrategy-tags.html .PARAMETER Value + The tag value can be up to 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deploymentstrategy-tags.html#cfn-appconfig-deploymentstrategy-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key-value string map. The valid character set is a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deploymentstrategy-tags.html#cfn-appconfig-deploymentstrategy-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentTags.ps1 index b9d1f9954..a357b8f5b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigDeploymentTags.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigDeploymentTags { <# .SYNOPSIS - Adds an AWS::AppConfig::Deployment.Tags resource property to the template. + Adds an AWS::AppConfig::Deployment.Tags resource property to the template. Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .DESCRIPTION Adds an AWS::AppConfig::Deployment.Tags resource property to the template. - +Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html .PARAMETER Value + The tag value can be up to 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html#cfn-appconfig-deployment-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key-value string map. The valid character set is a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html#cfn-appconfig-deployment-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentMonitors.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentMonitors.ps1 index 118862c58..957306c91 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentMonitors.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentMonitors.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigEnvironmentMonitors { <# .SYNOPSIS - Adds an AWS::AppConfig::Environment.Monitors resource property to the template. + Adds an AWS::AppConfig::Environment.Monitors resource property to the template. Amazon CloudWatch alarms to monitor during the deployment process. .DESCRIPTION Adds an AWS::AppConfig::Environment.Monitors resource property to the template. - +Amazon CloudWatch alarms to monitor during the deployment process. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitors.html .PARAMETER AlarmArn + ARN of the Amazon CloudWatch alarm. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitors.html#cfn-appconfig-environment-monitors-alarmarn PrimitiveType: String UpdateType: Mutable .PARAMETER AlarmRoleArn + ARN of an IAM role for AppConfig to monitor AlarmArn. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitors.html#cfn-appconfig-environment-monitors-alarmrolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentTags.ps1 index f0aef8ba5..ae00e5d04 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppConfigEnvironmentTags.ps1 @@ -1,21 +1,25 @@ function Add-VSAppConfigEnvironmentTags { <# .SYNOPSIS - Adds an AWS::AppConfig::Environment.Tags resource property to the template. + Adds an AWS::AppConfig::Environment.Tags resource property to the template. Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .DESCRIPTION Adds an AWS::AppConfig::Environment.Tags resource property to the template. - +Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-tags.html .PARAMETER Value + The tag value can be up to 256 characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-tags.html#cfn-appconfig-environment-tags-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The key-value string map. The valid character set is a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-tags.html#cfn-appconfig-environment-tags-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 index 2c4047986..ecfcc5c06 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshEgressFilter.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshMeshEgressFilter { <# .SYNOPSIS - Adds an AWS::AppMesh::Mesh.EgressFilter resource property to the template. An object representing the egress filter rules for a service mesh. + Adds an AWS::AppMesh::Mesh.EgressFilter resource property to the template. An object that represents the egress filter rules for a service mesh. .DESCRIPTION Adds an AWS::AppMesh::Mesh.EgressFilter resource property to the template. -An object representing the egress filter rules for a service mesh. +An object that represents the egress filter rules for a service mesh. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 index 6d6c4bdd7..c150a4d0d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshMeshMeshSpec.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshMeshMeshSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::Mesh.MeshSpec resource property to the template. An object representing the specification of a service mesh. + Adds an AWS::AppMesh::Mesh.MeshSpec resource property to the template. An object that represents the specification of a service mesh. .DESCRIPTION Adds an AWS::AppMesh::Mesh.MeshSpec resource property to the template. -An object representing the specification of a service mesh. +An object that represents the specification of a service mesh. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteDuration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteDuration.ps1 index 4b9f9bc9d..eba126b9d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteDuration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteDuration.ps1 @@ -1,21 +1,25 @@ function Add-VSAppMeshRouteDuration { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.Duration resource property to the template. + Adds an AWS::AppMesh::Route.Duration resource property to the template. An object that represents a duration of time. .DESCRIPTION Adds an AWS::AppMesh::Route.Duration resource property to the template. - +An object that represents a duration of time. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html .PARAMETER Value + A number of time units. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html#cfn-appmesh-route-duration-value PrimitiveType: Integer UpdateType: Mutable .PARAMETER Unit + A unit of time. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html#cfn-appmesh-route-duration-unit PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRetryPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRetryPolicy.ps1 index dbeb63a76..540fe1c73 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRetryPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRetryPolicy.ps1 @@ -1,38 +1,52 @@ function Add-VSAppMeshRouteGrpcRetryPolicy { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.GrpcRetryPolicy resource property to the template. + Adds an AWS::AppMesh::Route.GrpcRetryPolicy resource property to the template. An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. .DESCRIPTION Adds an AWS::AppMesh::Route.GrpcRetryPolicy resource property to the template. - +An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html .PARAMETER MaxRetries + The maximum number of retry attempts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-maxretries PrimitiveType: Integer UpdateType: Mutable .PARAMETER PerRetryTimeout + An object that represents a duration of time. + Type: Duration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-perretrytimeout UpdateType: Mutable .PARAMETER GrpcRetryEvents + Specify at least one of the valid values. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-grpcretryevents UpdateType: Mutable .PARAMETER HttpRetryEvents + Specify at least one of the following values. ++ **server-error** – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511 ++ **gateway-error** – HTTP status codes 502, 503, and 504 ++ **client-error** – HTTP status code 409 ++ **stream-error** – Retry on refused stream + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-httpretryevents UpdateType: Mutable .PARAMETER TcpRetryEvents + Specify a valid value. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-tcpretryevents diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRoute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRoute.ps1 index e2f8bf069..6400d92e1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRoute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRoute.ps1 @@ -1,26 +1,32 @@ function Add-VSAppMeshRouteGrpcRoute { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.GrpcRoute resource property to the template. + Adds an AWS::AppMesh::Route.GrpcRoute resource property to the template. An object that represents a gRPC route type. .DESCRIPTION Adds an AWS::AppMesh::Route.GrpcRoute resource property to the template. - +An object that represents a gRPC route type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html .PARAMETER Action + An object that represents the action to take if a match is determined. + Type: GrpcRouteAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-action UpdateType: Mutable .PARAMETER RetryPolicy + An object that represents a retry policy. + Type: GrpcRetryPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-retrypolicy UpdateType: Mutable .PARAMETER Match + An object that represents the criteria for determining a request match. + Type: GrpcRouteMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-match UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteAction.ps1 index 41a3d2f94..3a9c5ae54 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteAction.ps1 @@ -1,16 +1,18 @@ function Add-VSAppMeshRouteGrpcRouteAction { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.GrpcRouteAction resource property to the template. + Adds an AWS::AppMesh::Route.GrpcRouteAction resource property to the template. An object that represents the action to take if a match is determined. .DESCRIPTION Adds an AWS::AppMesh::Route.GrpcRouteAction resource property to the template. - +An object that represents the action to take if a match is determined. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcrouteaction.html .PARAMETER WeightedTargets + An object that represents the targets that traffic is routed to when a request matches the route. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcrouteaction.html#cfn-appmesh-route-grpcrouteaction-weightedtargets ItemType: WeightedTarget diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMatch.ps1 index e40709d84..01d6e8d25 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMatch.ps1 @@ -1,27 +1,33 @@ function Add-VSAppMeshRouteGrpcRouteMatch { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.GrpcRouteMatch resource property to the template. + Adds an AWS::AppMesh::Route.GrpcRouteMatch resource property to the template. An object that represents the criteria for determining a request match. .DESCRIPTION Adds an AWS::AppMesh::Route.GrpcRouteMatch resource property to the template. - +An object that represents the criteria for determining a request match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html .PARAMETER ServiceName + The fully qualified domain name for the service to match from the request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-servicename PrimitiveType: String UpdateType: Mutable .PARAMETER Metadata + An object that represents the data to match from the request. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-metadata ItemType: GrpcRouteMetadata UpdateType: Mutable .PARAMETER MethodName + The method name to match from the request. If you specify a name, you must also specify a serviceName. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-methodname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadata.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadata.ps1 index da6ecae20..4e67a4238 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadata.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadata.ps1 @@ -1,26 +1,32 @@ function Add-VSAppMeshRouteGrpcRouteMetadata { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.GrpcRouteMetadata resource property to the template. + Adds an AWS::AppMesh::Route.GrpcRouteMetadata resource property to the template. An object that represents the match metadata for the route. .DESCRIPTION Adds an AWS::AppMesh::Route.GrpcRouteMetadata resource property to the template. - +An object that represents the match metadata for the route. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html .PARAMETER Invert + Specify True to match anything except the match criteria. The default value is False. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html#cfn-appmesh-route-grpcroutemetadata-invert PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name + The name of the route. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html#cfn-appmesh-route-grpcroutemetadata-name PrimitiveType: String UpdateType: Mutable .PARAMETER Match + An object that represents the data to match from the request. + Type: GrpcRouteMetadataMatchMethod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html#cfn-appmesh-route-grpcroutemetadata-match UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadataMatchMethod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadataMatchMethod.ps1 index 2a4444fa7..e3b06a22f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadataMatchMethod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteGrpcRouteMetadataMatchMethod.ps1 @@ -1,36 +1,46 @@ function Add-VSAppMeshRouteGrpcRouteMetadataMatchMethod { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod resource property to the template. + Adds an AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod resource property to the template. An object that represents the match method. Specify one of the match values. .DESCRIPTION Adds an AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod resource property to the template. - +An object that represents the match method. Specify one of the match values. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html .PARAMETER Suffix + The value sent by the client must end with the specified characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-suffix PrimitiveType: String UpdateType: Mutable .PARAMETER Regex + The value sent by the client must include the specified characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-regex PrimitiveType: String UpdateType: Mutable .PARAMETER Exact + The value sent by the client must match the specified value exactly. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-exact PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix + The value sent by the client must begin with the specified characters. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Range + An object that represents the range of values to match on. + Type: MatchRange Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-range UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 index 7387af1f9..2192ffbd4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHeaderMatchMethod.ps1 @@ -1,45 +1,45 @@ function Add-VSAppMeshRouteHeaderMatchMethod { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HeaderMatchMethod resource property to the template. An object representing the method and value to match the header value sent with a request. Specify one match method. + Adds an AWS::AppMesh::Route.HeaderMatchMethod resource property to the template. An object that represents the method and value to match with the header value sent in a request. Specify one match method. .DESCRIPTION Adds an AWS::AppMesh::Route.HeaderMatchMethod resource property to the template. -An object representing the method and value to match the header value sent with a request. Specify one match method. +An object that represents the method and value to match with the header value sent in a request. Specify one match method. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html .PARAMETER Suffix - The header value sent by the client must end with the specified characters. + The value sent by the client must end with the specified characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-suffix PrimitiveType: String UpdateType: Mutable .PARAMETER Regex - The header value sent by the client must include the specified characters. + The value sent by the client must include the specified characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-regex PrimitiveType: String UpdateType: Mutable .PARAMETER Exact - The header value sent by the client must match the specified value exactly. + The value sent by the client must match the specified value exactly. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-exact PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix - The header value sent by the client must begin with the specified characters. + The value sent by the client must begin with the specified characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Range - The object that specifies the range of numbers that the header value sent by the client must be included in. + An object that represents the range of values to match on. Type: MatchRange Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-range diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRetryPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRetryPolicy.ps1 index 1fa54243e..d8de8f0f0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRetryPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRetryPolicy.ps1 @@ -1,32 +1,44 @@ function Add-VSAppMeshRouteHttpRetryPolicy { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRetryPolicy resource property to the template. + Adds an AWS::AppMesh::Route.HttpRetryPolicy resource property to the template. An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRetryPolicy resource property to the template. - +An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html .PARAMETER MaxRetries + The maximum number of retry attempts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-maxretries PrimitiveType: Integer UpdateType: Mutable .PARAMETER PerRetryTimeout + An object that represents a duration of time. + Type: Duration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-perretrytimeout UpdateType: Mutable .PARAMETER HttpRetryEvents + Specify at least one of the following values. ++ **server-error** – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511 ++ **gateway-error** – HTTP status codes 502, 503, and 504 ++ **client-error** – HTTP status code 409 ++ **stream-error** – Retry on refused stream + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-httpretryevents UpdateType: Mutable .PARAMETER TcpRetryEvents + Specify a valid value. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-tcpretryevents diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 index 5064560a7..c0098e338 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRoute.ps1 @@ -1,31 +1,31 @@ function Add-VSAppMeshRouteHttpRoute { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRoute resource property to the template. An object representing the HTTP routing specification for a route. + Adds an AWS::AppMesh::Route.HttpRoute resource property to the template. An object that represents an HTTP or HTTP/2 route type. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRoute resource property to the template. -An object representing the HTTP routing specification for a route. +An object that represents an HTTP or HTTP/2 route type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html .PARAMETER Action - The action to take if a match is determined. + An object that represents the action to take if a match is determined. Type: HttpRouteAction Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-action UpdateType: Mutable .PARAMETER RetryPolicy - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + An object that represents a retry policy. Type: HttpRetryPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-retrypolicy UpdateType: Mutable .PARAMETER Match - The criteria for determining an HTTP request match. + An object that represents the criteria for determining a request match. Type: HttpRouteMatch Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-match diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 index 7ebe74029..8ba712ef6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteAction.ps1 @@ -1,17 +1,17 @@ function Add-VSAppMeshRouteHttpRouteAction { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRouteAction resource property to the template. An object representing the traffic distribution requirements for matched HTTP requests. + Adds an AWS::AppMesh::Route.HttpRouteAction resource property to the template. An object that represents the action to take if a match is determined. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRouteAction resource property to the template. -An object representing the traffic distribution requirements for matched HTTP requests. +An object that represents the action to take if a match is determined. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html .PARAMETER WeightedTargets - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with. + An object that represents the targets that traffic is routed to when a request matches the route. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html#cfn-appmesh-route-httprouteaction-weightedtargets diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 index 576ac9905..ddd533126 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteHeader.ps1 @@ -1,17 +1,17 @@ function Add-VSAppMeshRouteHttpRouteHeader { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRouteHeader resource property to the template. An object representing the HTTP header in the request. + Adds an AWS::AppMesh::Route.HttpRouteHeader resource property to the template. An object that represents the HTTP header in the request. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRouteHeader resource property to the template. -An object representing the HTTP header in the request. +An object that represents the HTTP header in the request. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html .PARAMETER Invert - Specify True to match the opposite of the HeaderMatchMethod method and value. The default value is False. + Specify True to match anything except the match criteria. The default value is False. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-invert PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 index fe9d5562e..ea8a88da7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteHttpRouteMatch.ps1 @@ -1,24 +1,24 @@ function Add-VSAppMeshRouteHttpRouteMatch { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.HttpRouteMatch resource property to the template. An object representing the requirements for a route to match HTTP requests for a virtual router. + Adds an AWS::AppMesh::Route.HttpRouteMatch resource property to the template. An object that represents the requirements for a route to match HTTP requests for a virtual router. .DESCRIPTION Adds an AWS::AppMesh::Route.HttpRouteMatch resource property to the template. -An object representing the requirements for a route to match HTTP requests for a virtual router. +An object that represents the requirements for a route to match HTTP requests for a virtual router. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html .PARAMETER Scheme - The client request header scheme to match on. + The client request scheme to match on. Specify only one. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-scheme PrimitiveType: String UpdateType: Mutable .PARAMETER Headers - The client request headers to match on. + An object that represents the client request headers to match on. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-headers @@ -33,7 +33,7 @@ An object representing the requirements for a route to match HTTP requests for a UpdateType: Mutable .PARAMETER Method - The client request header method to match on. + The client request method to match on. Specify only one. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-method PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 index 7e52c01ac..a0b111a72 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteMatchRange.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshRouteMatchRange { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.MatchRange resource property to the template. The range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. + Adds an AWS::AppMesh::Route.MatchRange resource property to the template. An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. .DESCRIPTION Adds an AWS::AppMesh::Route.MatchRange resource property to the template. -The range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. +An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 index b2b585c6b..53b8f228e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteRouteSpec.ps1 @@ -1,45 +1,45 @@ function Add-VSAppMeshRouteRouteSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.RouteSpec resource property to the template. An object representing the specification of a route. + Adds an AWS::AppMesh::Route.RouteSpec resource property to the template. An object that represents a route specification. Specify one route type. .DESCRIPTION Adds an AWS::AppMesh::Route.RouteSpec resource property to the template. -An object representing the specification of a route. +An object that represents a route specification. Specify one route type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html .PARAMETER HttpRoute - The HTTP routing information for the route. + An object that represents the specification of an HTTP route. Type: HttpRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-httproute UpdateType: Mutable .PARAMETER Priority - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER Http2Route - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + An object that represents the specification of an HTTP/2 route. Type: HttpRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-http2route UpdateType: Mutable .PARAMETER GrpcRoute - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + An object that represents the specification of a gRPC route. Type: GrpcRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-grpcroute UpdateType: Mutable .PARAMETER TcpRoute - The TCP routing information for the route. + An object that represents the specification of a TCP route. Type: TcpRoute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-tcproute diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 index b155a5d75..a96ca336c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRoute.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshRouteTcpRoute { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.TcpRoute resource property to the template. An object representing the TCP routing specification for a route. + Adds an AWS::AppMesh::Route.TcpRoute resource property to the template. An object that represents a TCP route type. .DESCRIPTION Adds an AWS::AppMesh::Route.TcpRoute resource property to the template. -An object representing the TCP routing specification for a route. +An object that represents a TCP route type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 index fe2b13cb6..6edefe899 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteTcpRouteAction.ps1 @@ -1,17 +1,17 @@ function Add-VSAppMeshRouteTcpRouteAction { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.TcpRouteAction resource property to the template. An object representing the traffic distribution requirements for matched TCP requests. + Adds an AWS::AppMesh::Route.TcpRouteAction resource property to the template. An object that represents the action to take if a match is determined. .DESCRIPTION Adds an AWS::AppMesh::Route.TcpRouteAction resource property to the template. -An object representing the traffic distribution requirements for matched TCP requests. +An object that represents the action to take if a match is determined. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html .PARAMETER WeightedTargets - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with. + An object that represents the targets that traffic is routed to when a request matches the route. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html#cfn-appmesh-route-tcprouteaction-weightedtargets diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 index c165fc2e2..108e7edd2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshRouteWeightedTarget.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshRouteWeightedTarget { <# .SYNOPSIS - Adds an AWS::AppMesh::Route.WeightedTarget resource property to the template. An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. + Adds an AWS::AppMesh::Route.WeightedTarget resource property to the template. An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100. .DESCRIPTION Adds an AWS::AppMesh::Route.WeightedTarget resource property to the template. -An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. +An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 index 1ac944a15..ed5e991c9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAccessLog.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeAccessLog { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.AccessLog resource property to the template. An object representing the access logging information for a virtual node. + Adds an AWS::AppMesh::VirtualNode.AccessLog resource property to the template. An object that represents the access logging information for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.AccessLog resource property to the template. -An object representing the access logging information for a virtual node. +An object that represents the access logging information for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-accesslog.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 index e136db366..5b1d13a85 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeAwsCloudMapInstanceAttribute { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute resource property to the template. An object representing the AWS Cloud Map attribute information for your virtual node. + Adds an AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute resource property to the template. An object that represents the AWS Cloud Map attribute information for your virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute resource property to the template. -An object representing the AWS Cloud Map attribute information for your virtual node. +An object that represents the AWS Cloud Map attribute information for your virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 index c38c672eb..2764ceb65 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeAwsCloudMapServiceDiscovery { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery resource property to the template. An object representing the AWS Cloud Map service discovery information for your virtual node. + Adds an AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery resource property to the template. An object that represents the AWS Cloud Map service discovery information for your virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery resource property to the template. -An object representing the AWS Cloud Map service discovery information for your virtual node. +An object that represents the AWS Cloud Map service discovery information for your virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 index 4f8c1315a..597d4d75c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackend.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeBackend { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.Backend resource property to the template. An object representing the backends that a virtual node is expected to send outbound traffic to. + Adds an AWS::AppMesh::VirtualNode.Backend resource property to the template. An object that represents the backends that a virtual node is expected to send outbound traffic to. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.Backend resource property to the template. -An object representing the backends that a virtual node is expected to send outbound traffic to. +An object that represents the backends that a virtual node is expected to send outbound traffic to. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackendDefaults.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackendDefaults.ps1 new file mode 100644 index 000000000..f294c159c --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeBackendDefaults.ps1 @@ -0,0 +1,45 @@ +function Add-VSAppMeshVirtualNodeBackendDefaults { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.BackendDefaults resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.BackendDefaults resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backenddefaults.html + + .PARAMETER ClientPolicy + Type: ClientPolicy + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backenddefaults.html#cfn-appmesh-virtualnode-backenddefaults-clientpolicy + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.BackendDefaults')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + $ClientPolicy + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.BackendDefaults' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicy.ps1 new file mode 100644 index 000000000..e536eec4c --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicy.ps1 @@ -0,0 +1,45 @@ +function Add-VSAppMeshVirtualNodeClientPolicy { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.ClientPolicy resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.ClientPolicy resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicy.html + + .PARAMETER TLS + Type: ClientPolicyTls + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicy.html#cfn-appmesh-virtualnode-clientpolicy-tls + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.ClientPolicy')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + $TLS + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.ClientPolicy' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicyTls.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicyTls.ps1 new file mode 100644 index 000000000..ce43a855f --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeClientPolicyTls.ps1 @@ -0,0 +1,69 @@ +function Add-VSAppMeshVirtualNodeClientPolicyTls { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.ClientPolicyTls resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.ClientPolicyTls resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html + + .PARAMETER Validation + Type: TlsValidationContext + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-validation + UpdateType: Mutable + + .PARAMETER Enforce + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-enforce + PrimitiveType: Boolean + UpdateType: Mutable + + .PARAMETER Ports + PrimitiveItemType: Integer + Type: List + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-ports + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.ClientPolicyTls')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + $Validation, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Boolean","Vaporshell.Function" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Enforce, + [parameter(Mandatory = $false)] + $Ports + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.ClientPolicyTls' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 index 189c5d480..94f1668e5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeDnsServiceDiscovery.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeDnsServiceDiscovery { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.DnsServiceDiscovery resource property to the template. An object representing the DNS service discovery information for your virtual node. + Adds an AWS::AppMesh::VirtualNode.DnsServiceDiscovery resource property to the template. An object that represents the DNS service discovery information for your virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.DnsServiceDiscovery resource property to the template. -An object representing the DNS service discovery information for your virtual node. +An object that represents the DNS service discovery information for your virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 index db1fbb27e..5a89820b1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeFileAccessLog.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeFileAccessLog { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.FileAccessLog resource property to the template. An object representing an access log file. + Adds an AWS::AppMesh::VirtualNode.FileAccessLog resource property to the template. An object that represents an access log file. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.FileAccessLog resource property to the template. -An object representing an access log file. +An object that represents an access log file. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-fileaccesslog.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 index 9a1c6ee7d..d520d995a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeHealthCheck.ps1 @@ -1,17 +1,17 @@ function Add-VSAppMeshVirtualNodeHealthCheck { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.HealthCheck resource property to the template. An object representing the health check policy for a virtual node's listener. + Adds an AWS::AppMesh::VirtualNode.HealthCheck resource property to the template. An object that represents the health check policy for a virtual node's listener. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.HealthCheck resource property to the template. -An object representing the health check policy for a virtual node's listener. +An object that represents the health check policy for a virtual node's listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html .PARAMETER Path - The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored. + The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-path PrimitiveType: String @@ -46,7 +46,7 @@ An object representing the health check policy for a virtual node's listener. UpdateType: Mutable .PARAMETER Protocol - The protocol for the health check request. + The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol: https://github.com/grpc/grpc/blob/master/doc/health-checking.md. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-protocol PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 index 5eec9934a..087ebe68d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListener.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeListener { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.Listener resource property to the template. An object representing a listener for a virtual node. + Adds an AWS::AppMesh::VirtualNode.Listener resource property to the template. An object that represents a listener for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.Listener resource property to the template. -An object representing a listener for a virtual node. +An object that represents a listener for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html @@ -17,6 +17,13 @@ An object representing a listener for a virtual node. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-healthcheck UpdateType: Mutable + .PARAMETER TLS + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + + Type: ListenerTls + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-tls + UpdateType: Mutable + .PARAMETER PortMapping The port mapping information for the listener. @@ -33,6 +40,8 @@ An object representing a listener for a virtual node. ( [parameter(Mandatory = $false)] $HealthCheck, + [parameter(Mandatory = $false)] + $TLS, [parameter(Mandatory = $true)] $PortMapping ) diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTls.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTls.ps1 new file mode 100644 index 000000000..8da721e16 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTls.ps1 @@ -0,0 +1,61 @@ +function Add-VSAppMeshVirtualNodeListenerTls { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.ListenerTls resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.ListenerTls resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html + + .PARAMETER Mode + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html#cfn-appmesh-virtualnode-listenertls-mode + PrimitiveType: String + UpdateType: Mutable + + .PARAMETER Certificate + Type: ListenerTlsCertificate + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html#cfn-appmesh-virtualnode-listenertls-certificate + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.ListenerTls')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Mode, + [parameter(Mandatory = $true)] + $Certificate + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.ListenerTls' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsAcmCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsAcmCertificate.ps1 new file mode 100644 index 000000000..745232f69 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsAcmCertificate.ps1 @@ -0,0 +1,54 @@ +function Add-VSAppMeshVirtualNodeListenerTlsAcmCertificate { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.ListenerTlsAcmCertificate resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.ListenerTlsAcmCertificate resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsacmcertificate.html + + .PARAMETER CertificateArn + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsacmcertificate.html#cfn-appmesh-virtualnode-listenertlsacmcertificate-certificatearn + PrimitiveType: String + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.ListenerTlsAcmCertificate')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $CertificateArn + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.ListenerTlsAcmCertificate' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsCertificate.ps1 new file mode 100644 index 000000000..908fd6bec --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsCertificate.ps1 @@ -0,0 +1,52 @@ +function Add-VSAppMeshVirtualNodeListenerTlsCertificate { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.ListenerTlsCertificate resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.ListenerTlsCertificate resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html + + .PARAMETER ACM + Type: ListenerTlsAcmCertificate + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html#cfn-appmesh-virtualnode-listenertlscertificate-acm + UpdateType: Mutable + + .PARAMETER File + Type: ListenerTlsFileCertificate + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html#cfn-appmesh-virtualnode-listenertlscertificate-file + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.ListenerTlsCertificate')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + $ACM, + [parameter(Mandatory = $false)] + $File + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.ListenerTlsCertificate' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsFileCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsFileCertificate.ps1 new file mode 100644 index 000000000..7d0250120 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeListenerTlsFileCertificate.ps1 @@ -0,0 +1,70 @@ +function Add-VSAppMeshVirtualNodeListenerTlsFileCertificate { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html + + .PARAMETER PrivateKey + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html#cfn-appmesh-virtualnode-listenertlsfilecertificate-privatekey + PrimitiveType: String + UpdateType: Mutable + + .PARAMETER CertificateChain + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html#cfn-appmesh-virtualnode-listenertlsfilecertificate-certificatechain + PrimitiveType: String + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.ListenerTlsFileCertificate')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $PrivateKey, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $CertificateChain + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.ListenerTlsFileCertificate' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 index 04ee42d97..7d107bb09 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeLogging.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeLogging { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.Logging resource property to the template. An object representing the logging information for a virtual node. + Adds an AWS::AppMesh::VirtualNode.Logging resource property to the template. An object that represents the logging information for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.Logging resource property to the template. -An object representing the logging information for a virtual node. +An object that represents the logging information for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-logging.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 index 6f8fcc7c2..8de252176 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodePortMapping.ps1 @@ -18,7 +18,7 @@ An object representing a virtual node or virtual router listener port mapping. UpdateType: Mutable .PARAMETER Protocol - The protocol used for the port mapping. + The protocol used for the port mapping. Specify one protocol. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html#cfn-appmesh-virtualnode-portmapping-protocol PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 index fd22adf04..261081e57 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeServiceDiscovery.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeServiceDiscovery { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.ServiceDiscovery resource property to the template. An object representing the service discovery information for a virtual node. + Adds an AWS::AppMesh::VirtualNode.ServiceDiscovery resource property to the template. An object that represents the service discovery information for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.ServiceDiscovery resource property to the template. -An object representing the service discovery information for a virtual node. +An object that represents the service discovery information for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContext.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContext.ps1 new file mode 100644 index 000000000..8758ed8db --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContext.ps1 @@ -0,0 +1,45 @@ +function Add-VSAppMeshVirtualNodeTlsValidationContext { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.TlsValidationContext resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.TlsValidationContext resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontext.html + + .PARAMETER Trust + Type: TlsValidationContextTrust + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontext.html#cfn-appmesh-virtualnode-tlsvalidationcontext-trust + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContext')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + $Trust + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContext' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextAcmTrust.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextAcmTrust.ps1 new file mode 100644 index 000000000..45cd1097d --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextAcmTrust.ps1 @@ -0,0 +1,46 @@ +function Add-VSAppMeshVirtualNodeTlsValidationContextAcmTrust { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.TlsValidationContextAcmTrust resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.TlsValidationContextAcmTrust resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextacmtrust.html + + .PARAMETER CertificateAuthorityArns + PrimitiveItemType: String + Type: List + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextacmtrust.html#cfn-appmesh-virtualnode-tlsvalidationcontextacmtrust-certificateauthorityarns + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContextAcmTrust')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + $CertificateAuthorityArns + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContextAcmTrust' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextFileTrust.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextFileTrust.ps1 new file mode 100644 index 000000000..42fda0bf0 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextFileTrust.ps1 @@ -0,0 +1,54 @@ +function Add-VSAppMeshVirtualNodeTlsValidationContextFileTrust { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextfiletrust.html + + .PARAMETER CertificateChain + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextfiletrust.html#cfn-appmesh-virtualnode-tlsvalidationcontextfiletrust-certificatechain + PrimitiveType: String + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContextFileTrust')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $CertificateChain + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContextFileTrust' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextTrust.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextTrust.ps1 new file mode 100644 index 000000000..2f9ba94fa --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeTlsValidationContextTrust.ps1 @@ -0,0 +1,52 @@ +function Add-VSAppMeshVirtualNodeTlsValidationContextTrust { + <# + .SYNOPSIS + Adds an AWS::AppMesh::VirtualNode.TlsValidationContextTrust resource property to the template. + + .DESCRIPTION + Adds an AWS::AppMesh::VirtualNode.TlsValidationContextTrust resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html + + .PARAMETER ACM + Type: TlsValidationContextAcmTrust + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-tlsvalidationcontexttrust-acm + UpdateType: Mutable + + .PARAMETER File + Type: TlsValidationContextFileTrust + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-tlsvalidationcontexttrust-file + UpdateType: Mutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContextTrust')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + $ACM, + [parameter(Mandatory = $false)] + $File + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.AppMesh.VirtualNode.TlsValidationContextTrust' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 index 95de80bf2..5bcac1fcb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualNodeSpec.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualNodeVirtualNodeSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.VirtualNodeSpec resource property to the template. An object representing the specification of a virtual node. + Adds an AWS::AppMesh::VirtualNode.VirtualNodeSpec resource property to the template. An object that represents the specification of a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.VirtualNodeSpec resource property to the template. -An object representing the specification of a virtual node. +An object that represents the specification of a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html @@ -26,15 +26,22 @@ An object representing the specification of a virtual node. UpdateType: Mutable .PARAMETER Listeners - The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node. + The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-listeners ItemType: Listener UpdateType: Mutable + .PARAMETER BackendDefaults + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + + Type: BackendDefaults + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-backenddefaults + UpdateType: Mutable + .PARAMETER ServiceDiscovery - The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. + The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information. Type: ServiceDiscovery Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-servicediscovery @@ -72,6 +79,8 @@ An object representing the specification of a virtual node. })] $Listeners, [parameter(Mandatory = $false)] + $BackendDefaults, + [parameter(Mandatory = $false)] $ServiceDiscovery ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 index adfd52e0f..da7a60c34 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualNodeVirtualServiceBackend.ps1 @@ -1,15 +1,22 @@ function Add-VSAppMeshVirtualNodeVirtualServiceBackend { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualNode.VirtualServiceBackend resource property to the template. An object representing a virtual service backend for a virtual node. + Adds an AWS::AppMesh::VirtualNode.VirtualServiceBackend resource property to the template. An object that represents a virtual service backend for a virtual node. .DESCRIPTION Adds an AWS::AppMesh::VirtualNode.VirtualServiceBackend resource property to the template. -An object representing a virtual service backend for a virtual node. +An object that represents a virtual service backend for a virtual node. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html + .PARAMETER ClientPolicy + *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + + Type: ClientPolicy + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html#cfn-appmesh-virtualnode-virtualservicebackend-clientpolicy + UpdateType: Mutable + .PARAMETER VirtualServiceName The name of the virtual service that is acting as a virtual node backend. @@ -24,6 +31,8 @@ An object representing a virtual service backend for a virtual node. [cmdletbinding()] Param ( + [parameter(Mandatory = $false)] + $ClientPolicy, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 index 9c840d898..bb7f32c79 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterPortMapping.ps1 @@ -18,7 +18,7 @@ An object representing a virtual router listener port mapping. UpdateType: Mutable .PARAMETER Protocol - The protocol used for the port mapping. + The protocol used for the port mapping. Specify one protocol. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html#cfn-appmesh-virtualrouter-portmapping-protocol PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 index 0fd24683a..34b4c2607 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterListener.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualRouterVirtualRouterListener { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualRouter.VirtualRouterListener resource property to the template. An object representing a virtual router listener. + Adds an AWS::AppMesh::VirtualRouter.VirtualRouterListener resource property to the template. An object that represents a virtual router listener. .DESCRIPTION Adds an AWS::AppMesh::VirtualRouter.VirtualRouterListener resource property to the template. -An object representing a virtual router listener. +An object that represents a virtual router listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 index 0246b4064..84bd45313 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualRouterVirtualRouterSpec.ps1 @@ -1,17 +1,17 @@ function Add-VSAppMeshVirtualRouterVirtualRouterSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualRouter.VirtualRouterSpec resource property to the template. An object representing the specification of a virtual router. + Adds an AWS::AppMesh::VirtualRouter.VirtualRouterSpec resource property to the template. An object that represents the specification of a virtual router. .DESCRIPTION Adds an AWS::AppMesh::VirtualRouter.VirtualRouterSpec resource property to the template. -An object representing the specification of a virtual router. +An object that represents the specification of a virtual router. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html .PARAMETER Listeners - The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router. + The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html#cfn-appmesh-virtualrouter-virtualrouterspec-listeners diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 index 475f1bb1a..2bee16b20 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualServiceVirtualNodeServiceProvider { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualNodeServiceProvider resource property to the template. An object representing a virtual node service provider. + Adds an AWS::AppMesh::VirtualService.VirtualNodeServiceProvider resource property to the template. An object that represents a virtual node service provider. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualNodeServiceProvider resource property to the template. -An object representing a virtual node service provider. +An object that represents a virtual node service provider. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 index 120f501b7..5462087c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualServiceVirtualRouterServiceProvider { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualRouterServiceProvider resource property to the template. An object representing a virtual node service provider. + Adds an AWS::AppMesh::VirtualService.VirtualRouterServiceProvider resource property to the template. An object that represents a virtual node service provider. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualRouterServiceProvider resource property to the template. -An object representing a virtual node service provider. +An object that represents a virtual node service provider. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 index 6f145ad0b..c8d0f4ffe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceProvider.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualServiceVirtualServiceProvider { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualServiceProvider resource property to the template. An object representing the provider for a virtual service. + Adds an AWS::AppMesh::VirtualService.VirtualServiceProvider resource property to the template. An object that represents the provider for a virtual service. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualServiceProvider resource property to the template. -An object representing the provider for a virtual service. +An object that represents the provider for a virtual service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 index 2984ac30a..92794ea3f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppMeshVirtualServiceVirtualServiceSpec.ps1 @@ -1,11 +1,11 @@ function Add-VSAppMeshVirtualServiceVirtualServiceSpec { <# .SYNOPSIS - Adds an AWS::AppMesh::VirtualService.VirtualServiceSpec resource property to the template. An object representing the specification of a virtual service. + Adds an AWS::AppMesh::VirtualService.VirtualServiceSpec resource property to the template. An object that represents the specification of a virtual service. .DESCRIPTION Adds an AWS::AppMesh::VirtualService.VirtualServiceSpec resource property to the template. -An object representing the specification of a virtual service. +An object that represents the specification of a virtual service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderAccessEndpoint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderAccessEndpoint.ps1 index 780607820..6994a860c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderAccessEndpoint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamImageBuilderAccessEndpoint.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamImageBuilderAccessEndpoint { <# .SYNOPSIS - Adds an AWS::AppStream::ImageBuilder.AccessEndpoint resource property to the template. + Adds an AWS::AppStream::ImageBuilder.AccessEndpoint resource property to the template. Describes an interface VPC endpoint (interface endpoint that lets you create a private connection between the virtual private cloud (VPC that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint. .DESCRIPTION Adds an AWS::AppStream::ImageBuilder.AccessEndpoint resource property to the template. - +Describes an interface VPC endpoint (interface endpoint that lets you create a private connection between the virtual private cloud (VPC that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-accessendpoint.html .PARAMETER EndpointType + The type of interface endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-accessendpoint.html#cfn-appstream-imagebuilder-accessendpoint-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER VpceId + The identifier ID of the VPC in which the interface endpoint is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-accessendpoint.html#cfn-appstream-imagebuilder-accessendpoint-vpceid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackAccessEndpoint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackAccessEndpoint.ps1 index 2218cfee4..b20269e0b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackAccessEndpoint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppStreamStackAccessEndpoint.ps1 @@ -1,21 +1,25 @@ function Add-VSAppStreamStackAccessEndpoint { <# .SYNOPSIS - Adds an AWS::AppStream::Stack.AccessEndpoint resource property to the template. + Adds an AWS::AppStream::Stack.AccessEndpoint resource property to the template. Describes an interface VPC endpoint (interface endpoint that lets you create a private connection between the virtual private cloud (VPC that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint. .DESCRIPTION Adds an AWS::AppStream::Stack.AccessEndpoint resource property to the template. - +Describes an interface VPC endpoint (interface endpoint that lets you create a private connection between the virtual private cloud (VPC that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-accessendpoint.html .PARAMETER EndpointType + The type of interface endpoint. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-accessendpoint.html#cfn-appstream-stack-accessendpoint-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER VpceId + The identifier ID of the VPC in which the interface endpoint is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-accessendpoint.html#cfn-appstream-stack-accessendpoint-vpceid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDeltaSyncConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDeltaSyncConfig.ps1 index 324c813b1..834583bf0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDeltaSyncConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDeltaSyncConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSAppSyncDataSourceDeltaSyncConfig { <# .SYNOPSIS - Adds an AWS::AppSync::DataSource.DeltaSyncConfig resource property to the template. + Adds an AWS::AppSync::DataSource.DeltaSyncConfig resource property to the template. Describes a Delta Sync configuration. .DESCRIPTION Adds an AWS::AppSync::DataSource.DeltaSyncConfig resource property to the template. - +Describes a Delta Sync configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html .PARAMETER BaseTableTTL + The number of minutes an Item is stored in the datasource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html#cfn-appsync-datasource-deltasyncconfig-basetablettl PrimitiveType: String UpdateType: Mutable .PARAMETER DeltaSyncTableTTL + The number of minutes a Delta Sync log entry is stored in the Delta Sync table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html#cfn-appsync-datasource-deltasyncconfig-deltasynctablettl PrimitiveType: String UpdateType: Mutable .PARAMETER DeltaSyncTableName + The Delta Sync table name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html#cfn-appsync-datasource-deltasyncconfig-deltasynctablename PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 index fbb77ef55..01b985c5f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceDynamoDBConfig.ps1 @@ -27,14 +27,14 @@ DynamoDBConfig is a property of the AWS::AppSync::DataSource: https://docs.aws.a UpdateType: Mutable .PARAMETER Versioned - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Set to TRUE to use Conflict Detection and Resolution with this data source. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-versioned PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DeltaSyncConfig - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The DeltaSyncConfig for a versioned datasource. Type: DeltaSyncConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-deltasyncconfig diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 index 6c8fd7cbb..5d3c6aaf6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncDataSourceRdsHttpEndpointConfig.ps1 @@ -34,7 +34,7 @@ RdsHttpEndpointConfig is a property of the AWS AppSync DataSource RelationalData UpdateType: Mutable .PARAMETER DbClusterIdentifier - Amazon RDS cluster identifier. + Amazon RDS cluster ARN. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-rdshttpendpointconfig.html#cfn-appsync-datasource-rdshttpendpointconfig-dbclusteridentifier PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverCachingConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverCachingConfig.ps1 index f0eee3ef0..d0aa06065 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverCachingConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverCachingConfig.ps1 @@ -1,22 +1,28 @@ function Add-VSAppSyncResolverCachingConfig { <# .SYNOPSIS - Adds an AWS::AppSync::Resolver.CachingConfig resource property to the template. + Adds an AWS::AppSync::Resolver.CachingConfig resource property to the template. The caching configuration for a resolver that has caching enabled. .DESCRIPTION Adds an AWS::AppSync::Resolver.CachingConfig resource property to the template. - +The caching configuration for a resolver that has caching enabled. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html .PARAMETER CachingKeys + The caching keys for a resolver that has caching enabled. +Valid values are entries from the $context.identity and $context.arguments maps. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html#cfn-appsync-resolver-cachingconfig-cachingkeys UpdateType: Mutable .PARAMETER Ttl + The TTL in seconds for a resolver that has caching enabled. +Valid values are between 1 and 3600 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html#cfn-appsync-resolver-cachingconfig-ttl PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverLambdaConflictHandlerConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverLambdaConflictHandlerConfig.ps1 index ffeb6ed91..8742f2e60 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverLambdaConflictHandlerConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverLambdaConflictHandlerConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSAppSyncResolverLambdaConflictHandlerConfig { <# .SYNOPSIS - Adds an AWS::AppSync::Resolver.LambdaConflictHandlerConfig resource property to the template. + Adds an AWS::AppSync::Resolver.LambdaConflictHandlerConfig resource property to the template. The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler. .DESCRIPTION Adds an AWS::AppSync::Resolver.LambdaConflictHandlerConfig resource property to the template. - +The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-lambdaconflicthandlerconfig.html .PARAMETER LambdaConflictHandlerArn + The Arn for the Lambda function to use as the Conflict Handler. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-lambdaconflicthandlerconfig.html#cfn-appsync-resolver-lambdaconflicthandlerconfig-lambdaconflicthandlerarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverSyncConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverSyncConfig.ps1 index 60f61c29d..cb41167ba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverSyncConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAppSyncResolverSyncConfig.ps1 @@ -1,26 +1,39 @@ function Add-VSAppSyncResolverSyncConfig { <# .SYNOPSIS - Adds an AWS::AppSync::Resolver.SyncConfig resource property to the template. + Adds an AWS::AppSync::Resolver.SyncConfig resource property to the template. Describes a Sync configuration for a resolver. .DESCRIPTION Adds an AWS::AppSync::Resolver.SyncConfig resource property to the template. +Describes a Sync configuration for a resolver. +Contains information on which Conflict Detection as well as Resolution strategy should be performed when the resolver is invoked. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html .PARAMETER ConflictHandler + The Conflict Resolution strategy to perform in the event of a conflict. ++ **OPTIMISTIC_CONCURRENCY**: Resolve conflicts by rejecting mutations when versions do not match the latest version at the server. ++ **AUTOMERGE**: Resolve conflicts with the Automerge conflict resolution strategy. ++ **LAMBDA**: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html#cfn-appsync-resolver-syncconfig-conflicthandler PrimitiveType: String UpdateType: Mutable .PARAMETER ConflictDetection + The Conflict Detection strategy to use. ++ **VERSION**: Detect conflicts based on object versions for this resolver. ++ **NONE**: Do not detect conflicts when executing this resolver. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html#cfn-appsync-resolver-syncconfig-conflictdetection PrimitiveType: String UpdateType: Mutable .PARAMETER LambdaConflictHandlerConfig + The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler. + Type: LambdaConflictHandlerConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html#cfn-appsync-resolver-syncconfig-lambdaconflicthandlerconfig UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 index 02f34b67e..8ca0ddb1b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalableTargetScheduledAction.ps1 @@ -20,7 +20,7 @@ For more information, see PutScheduledAction: https://docs.aws.amazon.com/autosc UpdateType: Mutable .PARAMETER ScalableTargetAction - The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. + The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scalabletargetaction Type: ScalableTargetAction diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 index c118fef8c..4deda6f99 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyStepScalingPolicyConfiguration.ps1 @@ -21,8 +21,21 @@ For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscal .PARAMETER Cooldown The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events. -For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously but not excessively scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count. +For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously but not excessively scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out action are considered part of that capacity and only 1 additional task is added to the desired count. For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. +Application Auto Scaling provides a default value of 300 for the following scalable targets: ++ ECS services ++ Spot Fleet requests ++ EMR clusters ++ AppStream 2.0 fleets ++ Aurora DB clusters ++ Amazon SageMaker endpoint variants ++ Custom resources +For all other scalable targets, the default value is 0: ++ DynamoDB tables ++ DynamoDB global secondary indexes ++ Amazon Comprehend document classification endpoints ++ Lambda provisioned concurrency Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-cooldown PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 index afd419a46..c0ead9ba4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSApplicationAutoScalingScalingPolicyTargetTrackingScalingPolicyConfiguration.ps1 @@ -20,7 +20,7 @@ For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscal UpdateType: Mutable .PARAMETER DisableScaleIn - Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false. + Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-disablescalein PrimitiveType: Boolean @@ -36,6 +36,19 @@ For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscal .PARAMETER ScaleInCooldown The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. +Application Auto Scaling provides a default value of 300 for the following scalable targets: ++ ECS services ++ Spot Fleet requests ++ EMR clusters ++ AppStream 2.0 fleets ++ Aurora DB clusters ++ Amazon SageMaker endpoint variants ++ Custom resources +For all other scalable targets, the default value is 0: ++ DynamoDB tables ++ DynamoDB global secondary indexes ++ Amazon Comprehend document classification endpoints ++ Lambda provisioned concurrency Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleincooldown PrimitiveType: Integer @@ -43,7 +56,20 @@ The cooldown period is used to block subsequent scale-in requests until it has e .PARAMETER ScaleOutCooldown The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. -While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously but not excessively scale out. +While the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously but not excessively scale out. +Application Auto Scaling provides a default value of 300 for the following scalable targets: ++ ECS services ++ Spot Fleet requests ++ EMR clusters ++ AppStream 2.0 fleets ++ Aurora DB clusters ++ Amazon SageMaker endpoint variants ++ Custom resources +For all other scalable targets, the default value is 0: ++ DynamoDB tables ++ DynamoDB global secondary indexes ++ Amazon Comprehend document classification endpoints ++ Lambda provisioned concurrency Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleoutcooldown PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 index b8f061c62..7053854ae 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupMetricsCollection.ps1 @@ -13,7 +13,8 @@ For more information, see Monitoring Your Auto Scaling Groups and Instances Usin http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html .PARAMETER Granularity - The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute. + The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. +*Allowed Values*: 1Minute Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-granularity PrimitiveType: String @@ -21,6 +22,7 @@ For more information, see Monitoring Your Auto Scaling Groups and Instances Usin .PARAMETER Metrics The list of Auto Scaling group metrics to collect. If you specify Granularity and don't specify any metrics, all metrics are enabled. +*Allowed Values*: + GroupMinSize + GroupMaxSize + GroupDesiredCapacity diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 index 061942cc9..c63193ef9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingAutoScalingGroupNotificationConfiguration.ps1 @@ -13,7 +13,8 @@ For example snippets, see Auto Scaling Group with Notifications: https://docs.aw http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html .PARAMETER NotificationTypes - A list of event types that trigger a notification. Event types can include any of the following types: + A list of event types that trigger a notification. Event types can include any of the following types. +*Allowed Values*: + autoscaling:EC2_INSTANCE_LAUNCH + autoscaling:EC2_INSTANCE_LAUNCH_ERROR + autoscaling:EC2_INSTANCE_TERMINATE diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 index 09c25d1a9..f240d9f04 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingLaunchConfigurationBlockDeviceMapping.ps1 @@ -30,7 +30,8 @@ You can specify either VirtualName or Ebs, but not both. UpdateType: Mutable .PARAMETER NoDevice - Suppresses the device mapping. If this property is set to true for the root device, the instance might fail the Amazon EC2 health check. Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check. + Suppresses the device mapping. The only permitted value for this property is true. +If this property is set to true for the root device, the instance might fail the Amazon EC2 health check. Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-nodevice PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 index b05cd52cb..436fc1b6f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSAutoScalingScalingPolicyPredefinedMetricSpecification.ps1 @@ -11,19 +11,21 @@ PredefinedMetricSpecification is a subproperty of TargetTrackingConfiguration: h http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html .PARAMETER PredefinedMetricType - The metric type. + The metric type. The following predefined metrics are available. ++ ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. ++ ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group. ++ ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group. ++ ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceLabel - Identifies the resource associated with the metric type. The following predefined metrics are available: -+ ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. -+ ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group. -+ ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group. -+ ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group. -For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the property must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the property must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group. + Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group. +The format is app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where ++ app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and ++ targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 index d298a94d4..4daeb47ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanBackupRuleResourceType.ps1 @@ -32,7 +32,7 @@ Specifies an object containing properties used to schedule a task to back up a s UpdateType: Mutable .PARAMETER CopyActions - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Not currently supported by AWS CloudFormation. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-copyactions @@ -61,7 +61,7 @@ Specifies an object containing properties used to schedule a task to back up a s UpdateType: Mutable .PARAMETER RuleName - An optional display name for a backup rule. + A display name for a backup rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-rulename PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanCopyActionResourceType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanCopyActionResourceType.ps1 index b8962d70a..8cfe20f9d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanCopyActionResourceType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBackupBackupPlanCopyActionResourceType.ps1 @@ -1,21 +1,25 @@ function Add-VSBackupBackupPlanCopyActionResourceType { <# .SYNOPSIS - Adds an AWS::Backup::BackupPlan.CopyActionResourceType resource property to the template. + Adds an AWS::Backup::BackupPlan.CopyActionResourceType resource property to the template. The CopyActionResourceType property type specifies Not currently supported by AWS CloudFormation. for an AWS::Backup::BackupPlan: aws-resource-backup-backupplan.md. .DESCRIPTION Adds an AWS::Backup::BackupPlan.CopyActionResourceType resource property to the template. - +The CopyActionResourceType property type specifies Not currently supported by AWS CloudFormation. for an AWS::Backup::BackupPlan: aws-resource-backup-backupplan.md. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html .PARAMETER Lifecycle + Not currently supported by AWS CloudFormation. + Type: LifecycleResourceType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html#cfn-backup-backupplan-copyactionresourcetype-lifecycle UpdateType: Mutable .PARAMETER DestinationBackupVaultArn + Not currently supported by AWS CloudFormation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html#cfn-backup-backupplan-copyactionresourcetype-destinationbackupvaultarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 index fd3980a60..39ddff1f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBatchComputeEnvironmentComputeResources.ps1 @@ -11,28 +11,28 @@ Details of the compute resources managed by the compute environment. This parame http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html .PARAMETER SpotIamFleetRole - The Amazon Resource Name ARN of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html in the *AWS Batch User Guide*. + The Amazon Resource Name ARN of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy is not specified. For more information, see Amazon EC2 Spot Fleet Role: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-spotiamfleetrole PrimitiveType: String UpdateType: Immutable .PARAMETER MaxvCpus - The maximum number of EC2 vCPUs that an environment can reach. + The maximum number of Amazon EC2 vCPUs that an environment can reach. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus PrimitiveType: Integer UpdateType: Mutable .PARAMETER BidPercentage - The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest market price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. + The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest market price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage PrimitiveType: Integer UpdateType: Immutable .PARAMETER SecurityGroupIds - The EC2 security group that is associated with instances launched in the compute environment. + The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used. PrimitiveItemType: String Type: List @@ -55,14 +55,14 @@ Details of the compute resources managed by the compute environment. This parame UpdateType: Immutable .PARAMETER AllocationStrategy - + Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. + The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified. BEST_FIT_PROGRESSIVE will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per vCPU. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. For more information, see Allocation Strategies: https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy PrimitiveType: String UpdateType: Immutable .PARAMETER MinvCpus - The minimum number of EC2 vCPUs that an environment should maintain even if the compute environment is DISABLED. + The minimum number of Amazon EC2 vCPUs that an environment should maintain even if the compute environment is DISABLED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus PrimitiveType: Integer @@ -90,7 +90,7 @@ Details of the compute resources managed by the compute environment. This parame UpdateType: Immutable .PARAMETER InstanceTypes - The instances types that may be launched. You can specify instance families to launch any instance type within those families for example, c4 or p3, or you can specify specific sizes within a family such as c4.8xlarge. You can also choose optimal to pick instance types from the C, M, and R instance families on the fly that match the demand of your job queues. + The instances types that may be launched. You can specify instance families to launch any instance type within those families for example, c5 or p3, or you can specify specific sizes within a family such as c5.8xlarge. You can also choose optimal to pick instance types from the C, M, and R instance families on the fly that match the demand of your job queues. PrimitiveItemType: String Type: List @@ -98,7 +98,7 @@ Details of the compute resources managed by the compute environment. This parame UpdateType: Immutable .PARAMETER Ec2KeyPair - The EC2 key pair that is used for instances launched in the compute environment. + The Amazon EC2 key pair that is used for instances launched in the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair PrimitiveType: String @@ -119,7 +119,7 @@ Details of the compute resources managed by the compute environment. This parame UpdateType: Immutable .PARAMETER DesiredvCpus - The desired number of EC2 vCPUS in the compute environment. + The desired number of Amazon EC2 vCPUS in the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-desiredvcpus PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 index 34ee29454..91c17c2ad 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetBudgetData.ps1 @@ -9,14 +9,14 @@ Represents the output of the CreateBudget operation. The content consists of the This is the ARN pattern for a budget: -arn:aws:budgetservice::AccountId:budget/budgetName +arn:aws:budgets::AccountId:budget/budgetName .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html .PARAMETER BudgetLimit - The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget. -BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions. + The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget. +BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions. Type: Spend Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetlimit @@ -40,7 +40,14 @@ After the end date, AWS deletes the budget and all associated notifications and UpdateType: Mutable .PARAMETER PlannedBudgetLimits - + Budget: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_budget.html in the *AWS Cost Explorer Service Cost Management APIs* + A map containing multiple BudgetLimit, including current or future limits. +PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit. +For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds. +For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds. +If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods. +If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget. +After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget. +DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-plannedbudgetlimits PrimitiveType: Json @@ -68,14 +75,14 @@ AWS Budgets supports the following services as a filter for RI budgets: .PARAMETER CostTypes The types of costs that are included in this COST budget. -USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes. +USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes. Type: CostTypes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costtypes UpdateType: Mutable .PARAMETER BudgetType - Whether this budget tracks costs, usage, RI utilization, or RI coverage. + Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgettype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 index b8a7ccf15..0a2932d70 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetCostTypes.ps1 @@ -7,7 +7,7 @@ function Add-VSBudgetsBudgetCostTypes { Adds an AWS::Budgets::Budget.CostTypes resource property to the template. The types of cost that are included in a COST budget, such as tax and subscriptions. -USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes. +USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 index 2ae5452a9..9290a03a4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSBudgetsBudgetNotification.ps1 @@ -37,7 +37,7 @@ For example, if you have a budget for 200 dollars and you want to be notified wh UpdateType: Mutable .PARAMETER Threshold - The threshold that is associated with a notification. Thresholds are always a percentage. + The threshold that is associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-threshold PrimitiveType: Double diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 index e9d5c5391..92a229f4a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCacheBehavior.ps1 @@ -57,10 +57,8 @@ The only way to guarantee that viewers retrieve an object that was fetched from UpdateType: Mutable .PARAMETER TrustedSigners - A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. -If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the *Amazon CloudFront Developer Guide*. -If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. -To add, change, or remove one or more trusted signers, change Enabled to true if it's currently false, change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + Specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. +If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify a list of AWS account IDs. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the *Amazon CloudFront Developer Guide*. PrimitiveItemType: String Type: List @@ -122,7 +120,7 @@ If you pick the second choice for your Amazon S3 Origin, you may need to forward UpdateType: Mutable .PARAMETER ForwardedValues - A complex type that specifies how CloudFront handles query strings and cookies. + A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. Type: ForwardedValues Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-forwardedvalues diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 index 25ca409d0..9f4f8272a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCookies.ps1 @@ -11,7 +11,7 @@ A complex type that specifies whether you want CloudFront to forward cookies to http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html .PARAMETER WhitelistedNames - Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. + Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits: https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront in the *AWS General Reference*. diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 index ae1ed59fc..dc2af15d3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionCustomErrorResponse.ps1 @@ -21,7 +21,7 @@ For more information about custom error pages, see Customizing Error Responses: + Some Internet devices some firewalls and corporate proxies, for example intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors. + You might want to return a 200 status code OK and static website so your customers don't know that your website is down. -If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, , in the XML document. +If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsecode PrimitiveType: Integer @@ -29,7 +29,6 @@ If you specify a value for ResponseCode, you must also specify a value for Respo .PARAMETER ErrorCachingMinTTL The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. -If you don't want to specify a value, include an empty element, , in the XML document. For more information, see Customizing Error Responses: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html in the *Amazon CloudFront Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl @@ -47,7 +46,7 @@ For more information, see Customizing Error Responses: https://docs.aws.amazon.c The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*. + The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages. -If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, , in the XML document. +If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsepagepath diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 index 757ee0756..346eb3b3a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDefaultCacheBehavior.ps1 @@ -45,10 +45,8 @@ The only way to guarantee that viewers retrieve an object that was fetched from UpdateType: Mutable .PARAMETER TrustedSigners - A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. -If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the * Amazon CloudFront Developer Guide*. -If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. -To add, change, or remove one or more trusted signers, change Enabled to true if it's currently false, change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + Specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. +If you want to require signed URLs in requests for objects in the target origin, specify a list of AWS account IDs. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the * Amazon CloudFront Developer Guide*. PrimitiveItemType: String Type: List @@ -100,7 +98,7 @@ If you pick the second choice for your Amazon S3 Origin, you may need to forward UpdateType: Mutable .PARAMETER ForwardedValues - A complex type that specifies how CloudFront handles query strings and cookies. + A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. Type: ForwardedValues Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 index 5adfd56f3..5e6717c73 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionDistributionConfig.ps1 @@ -49,7 +49,7 @@ For more information about the default root object, see Creating a Default Root UpdateType: Mutable .PARAMETER ViewerCertificate - A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager ACM or a third-party certificate authority. + A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers. Type: ViewerCertificate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-viewercertificate @@ -111,8 +111,8 @@ If you created a CNAME resource record set, either with Amazon Route 53 or with UpdateType: Mutable .PARAMETER WebACLId - A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. -AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code Forbidden. You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide: http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html. + A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a. +AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code Forbidden. You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-webaclid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 index bbdaf2bb5..56b3cc44c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionForwardedValues.ps1 @@ -1,11 +1,11 @@ function Add-VSCloudFrontDistributionForwardedValues { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.ForwardedValues resource property to the template. A complex type that specifies how CloudFront handles query strings and cookies. + Adds an AWS::CloudFront::Distribution.ForwardedValues resource property to the template. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. .DESCRIPTION Adds an AWS::CloudFront::Distribution.ForwardedValues resource property to the template. -A complex type that specifies how CloudFront handles query strings and cookies. +A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html @@ -19,7 +19,7 @@ A complex type that specifies how CloudFront handles query strings and cookies. .PARAMETER Headers A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior whitelisted headers. For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. -For more information, see Caching Content Based on Request Headers: https://docs.aws.amazon.com/Cookies.html in the *Amazon CloudFront Developer Guide*. +For more information, see Caching Content Based on Request Headers: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html in the *Amazon CloudFront Developer Guide*. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 index 8116159f7..c570fff49 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionOrigin.ps1 @@ -1,13 +1,17 @@ function Add-VSCloudFrontDistributionOrigin { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.Origin resource property to the template. A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server, Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group. + Adds an AWS::CloudFront::Distribution.Origin resource property to the template. A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server, Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you’ve created an origin group. You must specify at least one origin or origin group. .DESCRIPTION Adds an AWS::CloudFront::Distribution.Origin resource property to the template. -A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server, Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group. +A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server, Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you’ve created an origin group. You must specify at least one origin or origin group. -For the current limit on the number of origins or origin groups that you can specify for a distribution, see Amazon CloudFront Limits: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront in the *AWS General Reference*. +For the current quota (limit on the number of origins or origin groups that you can specify for a distribution, see Quotas: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html in the *Amazon CloudFront Developer Guide*. + +**Note** + +If you use CloudFormation to create a CloudFront distribution and an S3 bucket origin at the same time, the distribution might return HTTP 307 Temporary Redirect responses for up to 24 hours. It can take up to 24 hours for the S3 bucket name to propagate to all AWS Regions. When the propagation is complete, the CloudFront distribution will automatically stop sending these redirect responses; you don’t need to take any action. For more information, see Why am I getting an HTTP 307 Temporary Redirect response from Amazon S3?: http://aws.amazon.com/premiumsupport/knowledge-center/s3-http-307-response/ and Temporary Request Redirection: https://docs.aws.amazon.com/AmazonS3/latest/dev/Redirects.html#TemporaryRedirection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 index 06ab0462f..2c121ff5d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontDistributionViewerCertificate.ps1 @@ -1,79 +1,83 @@ function Add-VSCloudFrontDistributionViewerCertificate { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution.ViewerCertificate resource property to the template. A complex type that specifies the following: + Adds an AWS::CloudFront::Distribution.ViewerCertificate resource property to the template. A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers. .DESCRIPTION Adds an AWS::CloudFront::Distribution.ViewerCertificate resource property to the template. -A complex type that specifies the following: +A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers. -+ Whether you want viewers to use HTTP or HTTPS to request your objects. +If the distribution doesn’t use Aliases (also known as alternate domain names or CNAMEs—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty. -+ If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net. +If the distribution uses Aliases (alternate domain names or CNAMEs, use the fields in this type to specify the following settings: -+ If you're using an alternate domain name, whether AWS Certificate Manager (ACM provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store. ++ Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI: https://en.wikipedia.org/wiki/Server_Name_Indication (recommended, or all viewers including those that don’t support SNI. -Specify only one of the following values: ++ To accept HTTPS connections from only viewers that support SNI, set SslSupportMethod to sni-only. This is recommended. Most browsers and clients released after 2010 support SNI. -+ ACMCertificateArn: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn ++ To accept HTTPS connections from all viewers, including those that don’t support SNI, set SslSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront. -+ IAMCertificateId: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId ++ The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy in the *Amazon CloudFront Developer Guide*. -+ CloudFrontDefaultCertificate: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-CloudFrontDefaultCertificate ++ The location of the SSL/TLS certificate, AWS Certificate Manager (ACM: https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html (recommended or AWS Identity and Access Management (AWS IAM: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html. You specify the location by setting a value in one of the following fields (not both: -For more information, see Using Alternate Domain Names and HTTPS: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS in the *Amazon CloudFront Developer Guide*. ++ AcmCertificateArn + ++ IamCertificateId + +All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig. + +For more information, see Using HTTPS with CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html and Using Alternate Domain Names and HTTPS: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html in the *Amazon CloudFront Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html .PARAMETER IamCertificateId - If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority: -+ IAM certificate ID where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store. -If you specify IAMCertificateId, you must also specify a value for SSLSupportMethod. + If the distribution uses Aliases alternate domain names or CNAMEs and the SSL/TLS certificate is stored in AWS Identity and Access Management AWS IAM: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html, provide the ID of the IAM certificate. +If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SslSupportMethod. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-iamcertificateid PrimitiveType: String UpdateType: Mutable .PARAMETER SslSupportMethod - If you specify a value for ACMCertificateArn: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn or for IAMCertificateId: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients. -+ sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication SNI. All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication: http://en.wikipedia.org/wiki/Server_Name_Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-https-dedicated-ip-or-sni.html in the *Amazon CloudFront Developer Guide*. -+ vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront: http://aws.amazon.com/cloudfront/custom-ssl-domains/ on the AWS marketing site. -Don't specify a value for SSLSupportMethod if you specified true. -For more information, see Choosing How CloudFront Serves HTTPS Requests: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-https-dedicated-ip-or-sni.html in the *Amazon CloudFront Developer Guide*. + If the distribution uses Aliases alternate domain names or CNAMEs, specify which viewers the distribution accepts HTTPS connections from. ++ sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication SNI: https://en.wikipedia.org/wiki/Server_Name_Indication. This is recommended. Most browsers and clients released after 2010 support SNI. ++ vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront. +If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod PrimitiveType: String UpdateType: Mutable .PARAMETER MinimumProtocolVersion - Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings: -+ The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers -+ The cipher that CloudFront uses to encrypt the content that it returns to viewers -On the CloudFront console, this setting is called **Security policy**. -We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later. -When both of the following are true, you must specify TLSv1 or later for the security policy: -+ You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId -+ You're using SNI: you specified sni-only for SSLSupportMethod -If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion. -For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers in the *Amazon CloudFront Developer Guide*. + If the distribution uses Aliases alternate domain names or CNAMEs, specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings: ++ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. ++ The ciphers that CloudFront can use to encrypt the content that it returns to viewers. +For more information, see Security Policy: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy and Supported Protocols and Ciphers Between Viewers and CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers in the *Amazon CloudFront Developer Guide*. +On the CloudFront console, this setting is called **Security Policy**. +We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that don’t support TLSv1.2. +When you’re using SNI only you set SslSupportMethod to sni-only, you must specify TLSv1 or higher. +If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net you set CloudFrontDefaultCertificate to true, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion PrimitiveType: String UpdateType: Mutable .PARAMETER CloudFrontDefaultCertificate - If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value: -+ true + If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true. +If the distribution uses Aliases alternate domain names or CNAMEs, omit this field and specify values for the following fields: ++ AcmCertificateArn or IamCertificateId specify a value for one, not both ++ MinimumProtocolVersion ++ SslSupportMethod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AcmCertificateArn - If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate: -+ ARN for ACM SSL/TLS certificate where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution. -If you specify ACMCertificateArn, you must also specify a value for SSLSupportMethod. + If the distribution uses Aliases alternate domain names or CNAMEs and the SSL/TLS certificate is stored in AWS Certificate Manager ACM: https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html, provide the Amazon Resource Name ARN of the ACM certificate. CloudFront only supports ACM certificates in the US East N. Virginia Region us-east-1. +If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SslSupportMethod. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 index 8770164f9..e47e26145 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudFrontStreamingDistributionTrustedSigners.ps1 @@ -1,19 +1,15 @@ function Add-VSCloudFrontStreamingDistributionTrustedSigners { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution.TrustedSigners resource property to the template. A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. + Adds an AWS::CloudFront::StreamingDistribution.TrustedSigners resource property to the template. Specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. .DESCRIPTION Adds an AWS::CloudFront::StreamingDistribution.TrustedSigners resource property to the template. -A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. +Specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. -If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the * Amazon CloudFront Developer Guide*. +If you want to require signed URLs in requests for objects in the target origin, specify true for Enabled, and specify a list of AWS account IDs. For more information, see Serving Private Content through CloudFront: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html in the * Amazon CloudFront Developer Guide*. -If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. - -To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false, change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. - -For more information about updating the distribution configuration, see DistributionConfig: https://docs.aws.amazon.com/cloudfront/latest/APIReference/DistributionConfig.html in the *Amazon CloudFront API Reference*. +If you don't want to require signed URLs in requests for objects, specify false for Enabled and omit the list of AWS account IDs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 index 8464ce469..2b522a707 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudTrailTrailDataResource.ps1 @@ -1,11 +1,11 @@ function Add-VSCloudTrailTrailDataResource { <# .SYNOPSIS - Adds an AWS::CloudTrail::Trail.DataResource resource property to the template. The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. + Adds an AWS::CloudTrail::Trail.DataResource resource property to the template. The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. .DESCRIPTION Adds an AWS::CloudTrail::Trail.DataResource resource property to the template. -The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. +The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. **Note** diff --git a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 index 4fb23b406..1f7d955e3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCloudWatchAlarmMetricStat.ps1 @@ -20,14 +20,18 @@ MetricStat is a property of the MetricDataQuery: https://docs.aws.amazon.com/AWS UpdateType: Mutable .PARAMETER Period - The period, in seconds, to use when retrieving the metric. + The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute 60 seconds and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second. +If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: ++ Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds 1 minute. ++ Start time between 15 and 63 days ago - Use a multiple of 300 seconds 5 minutes. ++ Start time greater than 63 days ago - Use a multiple of 3600 seconds 1 hour. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-period PrimitiveType: Integer UpdateType: Mutable .PARAMETER Stat - The statistic to return. It can include any CloudWatch statistic or extended statistic. + The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic in the *Amazon CloudWatch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-stat PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 index d47b2420e..b57b5a4eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectArtifacts.ps1 @@ -24,6 +24,8 @@ For example, if path is set to MyArtifacts, namespaceType is set to NONE, and na .PARAMETER Type The type of build output artifact. Valid values include: + CODEPIPELINE: The build project has build output generated through AWS CodePipeline. +**Note** +The CODEPIPELINE type is not supported for secondaryArtifacts. + NO_ARTIFACTS: The build project does not produce any build output. + S3: The build project stores build output in Amazon Simple Storage Service Amazon S3. diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 index 2bd711238..a08db337d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironment.ps1 @@ -12,6 +12,9 @@ Environment is a property of the AWS::CodeBuild::Project: https://docs.aws.amazo .PARAMETER Type The type of build environment to use for related builds. ++ The environment type ARM_CONTAINER is available only in regions US East N. Virginia, US East Ohio, US West Oregon, EU Ireland, Asia Pacific Mumbai, Asia Pacific Tokyo, Asia Pacific Sydney, and EU Frankfurt. ++ The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East N. Virginia, US East Ohio, US West Oregon, Canada Central, EU Ireland, EU London, EU Frankfurt, Asia Pacific Tokyo, Asia Pacific Seoul, Asia Pacific Singapore, Asia Pacific Sydney, China Beijing, and China Ningxia. ++ The environment type LINUX_GPU_CONTAINER is available only in regions US East N. Virginia, US East Ohio, US West Oregon, Canada Central, EU Ireland, EU London, EU Frankfurt, Asia Pacific Tokyo, Asia Pacific Seoul, Asia Pacific Singapore, Asia Pacific Sydney , China Beijing, and China Ningxia. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type PrimitiveType: String @@ -26,13 +29,12 @@ Environment is a property of the AWS::CodeBuild::Project: https://docs.aws.amazo UpdateType: Mutable .PARAMETER PrivilegedMode - Indicates how the project builds Docker images. Specify true to enable running the Docker daemon inside a Docker container. -This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. For more information, see the privilegedMode : https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-cli field in the *AWS CodeBuild User Guide*. -You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support. + Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false. +You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file: If the operating system's base image is Ubuntu Linux: - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout 15 sh -c "until docker info; do echo .; sleep 1; done" -If the operating system's base image is Alpine Linux, add the -t argument to timeout: +If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout: - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" @@ -73,6 +75,7 @@ When you use a cross-account or private registry image, you must use SERVICE_ROL + BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. + BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. + BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds. +For more information, see Build Environment Compute Types: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html in the *AWS CodeBuild User Guide.* Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 index a5546b837..3160f4166 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectEnvironmentVariable.ps1 @@ -13,7 +13,8 @@ EnvironmentVariable is a property of the AWS CodeBuild Project Environment: http .PARAMETER Type The type of environment variable. Valid values include: + PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. -+ PLAINTEXT: An environment variable in plaintext format. ++ PLAINTEXT: An environment variable in plain text format. This is the default value. ++ SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type PrimitiveType: String @@ -21,7 +22,7 @@ EnvironmentVariable is a property of the AWS CodeBuild Project Environment: http .PARAMETER Value The value of the environment variable. -We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface AWS CLI. +We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface AWS CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 index 9c119b27a..0cde1f039 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectFilterGroup.ps1 @@ -9,7 +9,7 @@ A list of WebhookFilter objects used to determine which webhook events are trigg *Required:* No -*Type:* A list of of WebhookFilter: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html objects +*Type:* A list of WebhookFilter: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html objects *Update requires:* No interruption diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 index a407a0a5a..5f889924b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectLogsConfig.ps1 @@ -1,11 +1,11 @@ function Add-VSCodeBuildProjectLogsConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.LogsConfig resource property to the template. LogsConfig is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/aws-properties-codebuild-project-source.html resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. + Adds an AWS::CodeBuild::Project.LogsConfig resource property to the template. LogsConfig is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. .DESCRIPTION Adds an AWS::CodeBuild::Project.LogsConfig resource property to the template. -LogsConfig is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/aws-properties-codebuild-project-source.html resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. +LogsConfig is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 index 9d9e1c50b..fd3c4c995 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectCache.ps1 @@ -1,11 +1,11 @@ function Add-VSCodeBuildProjectProjectCache { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.ProjectCache resource property to the template. ProjectCache is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about the cache for the build project. + Adds an AWS::CodeBuild::Project.ProjectCache resource property to the template. ProjectCache is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about the cache for the build project. If ProjectCache is not specified, then both of its properties default to NO_CACHE. .DESCRIPTION Adds an AWS::CodeBuild::Project.ProjectCache resource property to the template. -ProjectCache is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about the cache for the build project. +ProjectCache is a property of the AWS CodeBuild Project: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html resource that specifies information about the cache for the build project. If ProjectCache is not specified, then both of its properties default to NO_CACHE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html @@ -21,7 +21,7 @@ You should consider the security implications before you use a Docker layer cach + LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: + Only directories can be specified for caching. You cannot specify individual files. + Symlinks are used to reference cached directories. -+ Cached directories are linked to your build before it downloads its project sources. Cached items are overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. ++ Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 index ff29ff684..0a0be99ed 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectFileSystemLocation.ps1 @@ -1,36 +1,48 @@ function Add-VSCodeBuildProjectProjectFileSystemLocation { <# .SYNOPSIS - Adds an AWS::CodeBuild::Project.ProjectFileSystemLocation resource property to the template. + Adds an AWS::CodeBuild::Project.ProjectFileSystemLocation resource property to the template. Information about a file system created by Amazon Elastic File System (EFS. For more information, see What Is Amazon Elastic File System?: https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html .DESCRIPTION Adds an AWS::CodeBuild::Project.ProjectFileSystemLocation resource property to the template. - +Information about a file system created by Amazon Elastic File System (EFS. For more information, see What Is Amazon Elastic File System?: https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html .PARAMETER MountPoint + The location in the container where you mount the file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountpoint PrimitiveType: String UpdateType: Mutable .PARAMETER Type + The type of the file system. The one supported type is EFS. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-type PrimitiveType: String UpdateType: Mutable .PARAMETER Identifier + The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my-efs for identifier, a new environment variable is create named CODEBUILD_MY-EFS. +The identifier is used to mount your file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-identifier PrimitiveType: String UpdateType: Mutable .PARAMETER MountOptions + The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options: https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountoptions PrimitiveType: String UpdateType: Mutable .PARAMETER Location + A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory. +The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-location PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 index 3f076da47..9226b27c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectProjectSourceVersion.ps1 @@ -19,7 +19,7 @@ A source identifier and its corresponding version. .PARAMETER SourceVersion The source version for the corresponding source identifier. If specified, must be one of: -+ For AWS CodeCommit: the commit ID to use. ++ For AWS CodeCommit: the commit ID, branch, or Git tag to use. + For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID for example, pr/25. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. + For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. + For Amazon Simple Storage Service Amazon S3: the version ID of the object that represents the build input ZIP file to use. diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 index a9ebe8c7d..9fa0238c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectRegistryCredential.ps1 @@ -18,7 +18,7 @@ For more information, see Private Registry with AWS Secrets Manager Sample for A .PARAMETER Credential The Amazon Resource Name ARN or name of credentials created using AWS Secrets Manager. -The credential can use the name of the credentials only if they exist in your current region. +The credential can use the name of the credentials only if they exist in your current AWS Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credential PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 index c2cf45436..bd33e5cde 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildProjectSource.ps1 @@ -16,6 +16,7 @@ Source is a property of the AWS::CodeBuild::Project: https://docs.aws.amazon.com + CODECOMMIT: The source code is in an AWS CodeCommit repository. + CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. + GITHUB: The source code is in a GitHub repository. ++ GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise repository. + NO_SOURCE: The project does not have input source code. + S3: The source code is in an Amazon Simple Storage Service Amazon S3 input bucket. diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupReportExportConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupReportExportConfig.ps1 index 20f28d050..4a744a331 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupReportExportConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupReportExportConfig.ps1 @@ -1,21 +1,27 @@ function Add-VSCodeBuildReportGroupReportExportConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::ReportGroup.ReportExportConfig resource property to the template. + Adds an AWS::CodeBuild::ReportGroup.ReportExportConfig resource property to the template. Information about the location where the run of a report is exported. .DESCRIPTION Adds an AWS::CodeBuild::ReportGroup.ReportExportConfig resource property to the template. - +Information about the location where the run of a report is exported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html .PARAMETER S3Destination + A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported. + Type: S3ReportExportConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html#cfn-codebuild-reportgroup-reportexportconfig-s3destination UpdateType: Mutable .PARAMETER ExportConfigType + The export configuration type. Valid values are: ++ S3: The report results are exported to an S3 bucket. ++ NO_EXPORT: The report results are not exported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupS3ReportExportConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupS3ReportExportConfig.ps1 index c7319b504..cc2ec6a10 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupS3ReportExportConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeBuildReportGroupS3ReportExportConfig.ps1 @@ -1,36 +1,48 @@ function Add-VSCodeBuildReportGroupS3ReportExportConfig { <# .SYNOPSIS - Adds an AWS::CodeBuild::ReportGroup.S3ReportExportConfig resource property to the template. + Adds an AWS::CodeBuild::ReportGroup.S3ReportExportConfig resource property to the template. Information about the S3 bucket where the raw data of a report are exported. .DESCRIPTION Adds an AWS::CodeBuild::ReportGroup.S3ReportExportConfig resource property to the template. - +Information about the S3 bucket where the raw data of a report are exported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html .PARAMETER Path + The path to the exported report's raw data results. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-path PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket + The name of the S3 bucket where the raw data of a report are exported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Packaging + The type of build output artifact to create. Valid values include: ++ NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. ++ ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-packaging PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionKey + The encryption key for the report's encrypted raw data. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionDisabled + A boolean value that specifies if the results of a report are encrypted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 index 1d2f15304..6a6095211 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeCommitRepositoryRepositoryTrigger.ps1 @@ -11,7 +11,7 @@ Information about a trigger for a repository. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html .PARAMETER Events - The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon SNS. + The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS. The valid value "all" cannot be used with any other values. PrimitiveItemType: String @@ -20,7 +20,7 @@ The valid value "all" cannot be used with any other values. UpdateType: Mutable .PARAMETER Branches - The branches that will be included in the trigger configuration. If you specify an empty array, the trigger will apply to all branches. + The branches to be included in the trigger configuration. If you specify an empty array, the trigger applies to all branches. Although no content is required in the array, you must include the array itself. PrimitiveItemType: String @@ -29,14 +29,14 @@ Although no content is required in the array, you must include the array itself. UpdateType: Mutable .PARAMETER CustomData - Any custom data associated with the trigger that will be included in the information sent to the target of the trigger. + Any custom data associated with the trigger to be included in the information sent to the target of the trigger. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-customdata PrimitiveType: String UpdateType: Mutable .PARAMETER DestinationArn - The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon SNS. + The ARN of the resource that is the target for a trigger for example, the ARN of a topic in Amazon SNS. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-destinationarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 index 83e643215..8bec0300a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupDeploymentStyle.ps1 @@ -12,6 +12,7 @@ Information about the type of deployment, either in-place or blue/green, you wan .PARAMETER DeploymentOption Indicates whether to route deployment traffic behind a load balancer. +An EC2 Application Load Balancer or Network Load Balancer is required for an Amazon ECS deployment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymentoption PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 index d8c3d99ac..2fb41ef21 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupLoadBalancerInfo.ps1 @@ -11,7 +11,7 @@ For AWS CloudFormation to use the properties specified in LoadBalancerInfo, the **Note** -AWS CloudFormation supports blue/green deployments on EC2/On-premises compute platforms only. +AWS CloudFormation supports blue/green deployments on the AWS Lambda compute platform only. LoadBalancerInfo is a property of the DeploymentGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html resource. diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 index 796dd1f50..cb4ee0b37 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeDeployDeploymentGroupRevisionLocation.ps1 @@ -22,6 +22,7 @@ RevisionLocation is a property that defines the location of the CodeDeploy appli + S3: An application revision stored in Amazon S3. + GitHub: An application revision stored in GitHub EC2/On-premises deployments only. + String: A YAML-formatted or JSON-formatted string AWS Lambda deployments only. ++ AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-revisiontype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 index 768117c2b..e0bd74308 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeConfigurationProperties.ps1 @@ -15,7 +15,7 @@ You can refer to a name in the configuration properties of the custom action wit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html .PARAMETER Description - The description of the action configuration property that will be displayed to users. + The description of the action configuration property that is displayed to users. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description PrimitiveType: String @@ -36,8 +36,8 @@ You can refer to a name in the configuration properties of the custom action wit UpdateType: Mutable .PARAMETER Queryable - Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. -If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty 20 characters. The value can contain only alphanumeric characters, underscores, and hyphens. + Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. +If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty 20 characters. The value can contain only alphanumeric characters, underscores, and hyphens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable PrimitiveType: Boolean @@ -52,7 +52,7 @@ If you create a pipeline with a custom action type, and that custom action conta .PARAMETER Secret Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. -When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret. +When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 index 03029b605..fc876653e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineCustomActionTypeSettings.ps1 @@ -11,14 +11,14 @@ Settings is a property of the AWS::CodePipeline::CustomActionType resource that http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html .PARAMETER EntityUrlTemplate - The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline. + The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ExecutionUrlTemplate - The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. + The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 index a5c6ba8cb..c14f942d5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionDeclaration.ps1 @@ -11,14 +11,17 @@ Represents information about an action declaration. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html .PARAMETER ActionTypeId - The configuration information for the action type. + Specifies the action type and the provider of the action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid Type: ActionTypeId UpdateType: Mutable .PARAMETER Configuration - The action declaration's configuration. + The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html in the *AWS CloudFormation User Guide*. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html in the *AWS CloudFormation User Guide*. +The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: +*JSON:* +"Configuration" : { Key : Value }, Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration PrimitiveType: Json @@ -41,7 +44,7 @@ Represents information about an action declaration. UpdateType: Mutable .PARAMETER Namespace - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The variable namespace associated with the action. All variables produced as output by this action fall under this namespace. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-actiondeclaration-namespace PrimitiveType: String @@ -64,7 +67,7 @@ Represents information about an action declaration. UpdateType: Mutable .PARAMETER RoleArn - The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline. + The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 index 661e7a32b..9d5e30f86 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineActionTypeId.ps1 @@ -12,20 +12,26 @@ Represents information about an action type. .PARAMETER Category A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. ++ Source ++ Build ++ Test ++ Deploy ++ Invoke ++ Approval Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category PrimitiveType: String UpdateType: Mutable .PARAMETER Owner - The creator of the action being called. + The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner PrimitiveType: String UpdateType: Mutable .PARAMETER Provider - The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers. + The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 index b25fbe4b6..729ce6813 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStore.ps1 @@ -1,24 +1,28 @@ function Add-VSCodePipelinePipelineArtifactStore { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.ArtifactStore resource property to the template. The Amazon S3 bucket where artifacts are stored for the pipeline. + Adds an AWS::CodePipeline::Pipeline.ArtifactStore resource property to the template. The S3 bucket where artifacts for the pipeline are stored. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.ArtifactStore resource property to the template. -The Amazon S3 bucket where artifacts are stored for the pipeline. +The S3 bucket where artifacts for the pipeline are stored. + +**Note** + +You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html .PARAMETER EncryptionKey - The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service AWS KMS key. If this is undefined, the default key for Amazon S3 is used. + The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service AWS KMS key. If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: AWS::CodePipeline::Pipeline: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey Type: EncryptionKey UpdateType: Mutable .PARAMETER Location - The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts. + The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 index 781580e29..c4d20f9f7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineArtifactStoreMap.ps1 @@ -1,19 +1,22 @@ function Add-VSCodePipelinePipelineArtifactStoreMap { <# .SYNOPSIS - Adds an AWS::CodePipeline::Pipeline.ArtifactStoreMap resource property to the template. A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. + Adds an AWS::CodePipeline::Pipeline.ArtifactStoreMap resource property to the template. A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. .DESCRIPTION Adds an AWS::CodePipeline::Pipeline.ArtifactStoreMap resource property to the template. -A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. +A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. -If you create a cross-region action in your pipeline, you must use artifactStores. +**Note** + +You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html .PARAMETER ArtifactStore - Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline. + Represents information about the S3 bucket where artifacts are stored for the pipeline. +You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore Type: ArtifactStore diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 index c20e5f5ec..dde2175c6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineEncryptionKey.ps1 @@ -11,7 +11,8 @@ Represents information about the key used to encrypt data in the artifact store, http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html .PARAMETER Id - The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN. + The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. +Aliases are recognized only in the account that created the customer master key CMK. For cross-account actions, you can only use the key ID or key ARN to identify the key. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 index 49a69e20a..501170b9d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineInputArtifact.ps1 @@ -11,7 +11,7 @@ Represents information about an artifact to be worked on, such as a test or buil http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html .PARAMETER Name - The name of the artifact to be worked on, for example, "My App". + The name of the artifact to be worked on for example, "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 index 03b79de09..59ea87368 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelinePipelineStageTransition.ps1 @@ -11,7 +11,7 @@ The name of the pipeline in which you want to disable the flow of artifacts from http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html .PARAMETER Reason - The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI. + The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 index b4437b3b8..387934028 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookAuthConfiguration.ps1 @@ -11,7 +11,7 @@ The authentication applied to incoming webhook trigger requests. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html .PARAMETER AllowedIPRange - The property used to configure acceptance of webhooks within a specific IP range. For IP, only the AllowedIPRange property must be set, and this property must be set to a valid CIDR range. + The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 index 1abfec385..aeac06a69 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodePipelineWebhookWebhookFilterRule.ps1 @@ -11,14 +11,14 @@ The event criteria that specify when a webhook notification is sent to your URL. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html .PARAMETER JsonPath - A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field, otherwise the request will be ignored. For more information about JsonPath expressions, see Java JsonPath implementation: https://github.com/json-path/JsonPath in GitHub. + A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation: https://github.com/json-path/JsonPath in GitHub. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath PrimitiveType: String UpdateType: Mutable .PARAMETER MatchEquals - The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements. + The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCodeStarNotificationsNotificationRuleTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCodeStarNotificationsNotificationRuleTarget.ps1 index 7748d7c60..3b992f6b8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCodeStarNotificationsNotificationRuleTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCodeStarNotificationsNotificationRuleTarget.ps1 @@ -1,21 +1,25 @@ function Add-VSCodeStarNotificationsNotificationRuleTarget { <# .SYNOPSIS - Adds an AWS::CodeStarNotifications::NotificationRule.Target resource property to the template. + Adds an AWS::CodeStarNotifications::NotificationRule.Target resource property to the template. Information about the SNS topics associated with a notification rule. .DESCRIPTION Adds an AWS::CodeStarNotifications::NotificationRule.Target resource property to the template. - +Information about the SNS topics associated with a notification rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html .PARAMETER TargetType + The target type. Can be an Amazon SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html#cfn-codestarnotifications-notificationrule-target-targettype PrimitiveType: String UpdateType: Mutable .PARAMETER TargetAddress + The Amazon Resource Name ARN of the SNS topic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html#cfn-codestarnotifications-notificationrule-target-targetaddress PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 index 9d94e8c79..37d97f740 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoIdentityProvider.ps1 @@ -12,15 +12,15 @@ CognitoIdentityProvider is a property of the AWS::Cognito::IdentityPool: https:/ .PARAMETER ServerSideTokenCheck TRUE if server-side token validation is enabled for the identity provider’s token. -Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. -If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error. +After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. +If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-serversidetokencheck PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ProviderName - The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789. + The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-providername PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 index f41e5f3e5..d11ffa35c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolCognitoStreams.ps1 @@ -18,7 +18,7 @@ CognitoStreams is a property of the AWS::Cognito::IdentityPool: https://docs.aws UpdateType: Mutable .PARAMETER StreamName - The name of the Amazon Cognito stream to receive updates. This stream must be in the developer's account and in the same region as the identity pool. + The name of the Amazon Cognito stream to receive updates. This stream must be in the developer's account and in the same Region as the identity pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 index a04e5da87..cefd85b19 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolPushSync.ps1 @@ -11,7 +11,7 @@ PushSync is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html .PARAMETER ApplicationArns - List of Amazon SNS platform application ARNs that could be used by clients. + The ARNs of the Amazon SNS platform applications that could be used by clients. PrimitiveItemType: String Type: List @@ -19,7 +19,7 @@ PushSync is a property of the AWS::Cognito::IdentityPool: https://docs.aws.amazo UpdateType: Mutable .PARAMETER RoleArn - An IAM role configured to allow Amazon Cognito to call SNS on behalf of the developer. + An IAM role configured to allow Amazon Cognito to call Amazon SNS on behalf of the developer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 index 9c5ee9ec9..14eb1fbfc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentMappingRule.ps1 @@ -19,14 +19,14 @@ Valid values are: Equals, Contains, StartsWith, and NotEqual. UpdateType: Mutable .PARAMETER Value - A brief string that the claim must match, for example, "paid" or "yes." + A brief string that the claim must match. For example, "paid" or "yes". Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value PrimitiveType: String UpdateType: Mutable .PARAMETER Claim - The claim name that must be present in the token, for example, "isAdmin" or "paid." + The claim name that must be present in the token. For example: "isAdmin" or "paid". Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 index 46f7622a9..06ed2d395 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping.ps1 @@ -1,17 +1,17 @@ function Add-VSCognitoIdentityPoolRoleAttachmentRoleMapping { <# .SYNOPSIS - Adds an AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping resource property to the template. RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html resource that defines the role mapping attributes of an Amazon Cognito identity pool. + Adds an AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping resource property to the template. RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html resource that defines the role-mapping attributes of an Amazon Cognito identity pool. .DESCRIPTION Adds an AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping resource property to the template. -RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html resource that defines the role mapping attributes of an Amazon Cognito identity pool. +RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html resource that defines the role-mapping attributes of an Amazon Cognito identity pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html .PARAMETER Type - The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Amazon Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role. + The role-mapping type. Token uses cognito:roles and cognito:preferred_role claims from the Amazon Cognito identity provider token to map groups to roles. Rules attempts to match claims from the token to map to a role. Valid values are Token or Rules. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-type @@ -27,14 +27,15 @@ Valid values are AuthenticatedRole or Deny. UpdateType: Mutable .PARAMETER RulesConfiguration - The rules to be used for mapping users to roles. If you specify Rules as the role mapping type, RulesConfiguration is required. + The rules to be used for mapping users to roles. If you specify "Rules" as the role-mapping type, RulesConfiguration is required. Type: RulesConfigurationType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-rulesconfiguration UpdateType: Mutable .PARAMETER IdentityProvider - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Identifier for the identity provider for which the role is mapped. For example: "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id http://cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". This is the identity provider that is used by the user for authentication. +If the identity provider property isn't provided, the key of the entry in the RoleMappings map is used as the identity provider. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-identityprovider PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 index ab0466a36..f276b262c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoIdentityPoolRoleAttachmentRulesConfigurationType.ps1 @@ -11,7 +11,7 @@ RulesConfigurationType is a subproperty of the RoleMapping: https://docs.aws.ama http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html .PARAMETER Rules - A list of rules. You can specify up to 25 rules per identity provider. + The rules. You can specify up to 25 rules per identity provider. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html#cfn-cognito-identitypoolroleattachment-rulesconfigurationtype-rules diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAccountRecoverySetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAccountRecoverySetting.ps1 index 1df4507a1..903a9c4e9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAccountRecoverySetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAccountRecoverySetting.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoUserPoolAccountRecoverySetting { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.AccountRecoverySetting resource property to the template. + Adds an AWS::Cognito::UserPool.AccountRecoverySetting resource property to the template. Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email. .DESCRIPTION Adds an AWS::Cognito::UserPool.AccountRecoverySetting resource property to the template. - +Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-accountrecoverysetting.html .PARAMETER RecoveryMechanisms + The list of RecoveryOptionTypes. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-accountrecoverysetting.html#cfn-cognito-userpool-accountrecoverysetting-recoverymechanisms ItemType: RecoveryOption diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 index 56c2c5529..d15bbaa0c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolAdminCreateUserConfig.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolAdminCreateUserConfig { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.AdminCreateUserConfig resource property to the template. AdminCreateUserConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource. The AdminCreateUserConfig property configures the AdminCreateUser requests for an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.AdminCreateUserConfig resource property to the template. The configuration for AdminCreateUser requests. .DESCRIPTION Adds an AWS::Cognito::UserPool.AdminCreateUserConfig resource property to the template. -AdminCreateUserConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource. The AdminCreateUserConfig property configures the AdminCreateUser requests for an Amazon Cognito User Pool. +The configuration for AdminCreateUser requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 index 31152aeb5..a5a3e837b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolClientAnalyticsConfiguration.ps1 @@ -1,11 +1,15 @@ function Add-VSCognitoUserPoolClientAnalyticsConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolClient.AnalyticsConfiguration resource property to the template. AnalyticsConfiguration is a property of the AWS::Cognito::UserPoolClient: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html resource that defines the Amazon Pinpoint analytics configuration for collecting metrics for this user pool. + Adds an AWS::Cognito::UserPoolClient.AnalyticsConfiguration resource property to the template. The Amazon Pinpoint analytics configuration for collecting metrics for a user pool. .DESCRIPTION Adds an AWS::Cognito::UserPoolClient.AnalyticsConfiguration resource property to the template. -AnalyticsConfiguration is a property of the AWS::Cognito::UserPoolClient: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html resource that defines the Amazon Pinpoint analytics configuration for collecting metrics for this user pool. +The Amazon Pinpoint analytics configuration for collecting metrics for a user pool. + +**Note** + +Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia us-east-1 Region, regardless of the region in which the user pool resides. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 index c9b21487f..21a56105c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDeviceConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolDeviceConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.DeviceConfiguration resource property to the template. DeviceConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the device configuration of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.DeviceConfiguration resource property to the template. The configuration for the user pool's device tracking. .DESCRIPTION Adds an AWS::Cognito::UserPool.DeviceConfiguration resource property to the template. -DeviceConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the device configuration of an Amazon Cognito User Pool. +The configuration for the user pool's device tracking. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDomainCustomDomainConfigType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDomainCustomDomainConfigType.ps1 index db9e2675a..d6d133711 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDomainCustomDomainConfigType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolDomainCustomDomainConfigType.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoUserPoolDomainCustomDomainConfigType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolDomain.CustomDomainConfigType resource property to the template. + Adds an AWS::Cognito::UserPoolDomain.CustomDomainConfigType resource property to the template. The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application. .DESCRIPTION Adds an AWS::Cognito::UserPoolDomain.CustomDomainConfigType resource property to the template. - +The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html .PARAMETER CertificateArn + The Amazon Resource Name ARN of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html#cfn-cognito-userpooldomain-customdomainconfigtype-certificatearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 index 3ab14bfb2..0df914305 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolEmailConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolEmailConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.EmailConfiguration resource property to the template. EmailConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the email configuration of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.EmailConfiguration resource property to the template. The email configuration. .DESCRIPTION Adds an AWS::Cognito::UserPool.EmailConfiguration resource property to the template. -EmailConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the email configuration of an Amazon Cognito User Pool. +The email configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html @@ -18,7 +18,9 @@ EmailConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws UpdateType: Mutable .PARAMETER ConfigurationSet - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails: ++ Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as SNS and CloudWatch. ++ IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-configurationset PrimitiveType: String @@ -49,7 +51,7 @@ Before Amazon Cognito can email your users, it requires additional permissions t UpdateType: Mutable .PARAMETER From - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Identifies either the sender's email address or the sender's name with their email address. For example, testuser@example.com or Test User . This address appears before the body of the email. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-from PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 index 304bf1ca1..82318f343 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolInviteMessageTemplate.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolInviteMessageTemplate { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.InviteMessageTemplate resource property to the template. InviteMessageTemplate is a subproperty of the AdminCreateUserConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html property that defines the email and SMS invitation message structure of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.InviteMessageTemplate resource property to the template. The message template to be used for the welcome message to new users. .DESCRIPTION Adds an AWS::Cognito::UserPool.InviteMessageTemplate resource property to the template. -InviteMessageTemplate is a subproperty of the AdminCreateUserConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html property that defines the email and SMS invitation message structure of an Amazon Cognito User Pool. +The message template to be used for the welcome message to new users. See also Customizing User Invitation Messages: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization. diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 index d0a540d32..c19b3ad36 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolLambdaConfig.ps1 @@ -1,19 +1,11 @@ function Add-VSCognitoUserPoolLambdaConfig { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.LambdaConfig resource property to the template. LambdaConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the AWS Lambda configuration of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.LambdaConfig resource property to the template. Specifies the configuration for AWS Lambda triggers. .DESCRIPTION Adds an AWS::Cognito::UserPool.LambdaConfig resource property to the template. -LambdaConfig is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the AWS Lambda configuration of an Amazon Cognito User Pool. - -**Note** - -In a push model, event sources (such as Amazon S3 and custom applications need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function. - -For more information on using the Lambda API to add permission, see AddPermission : https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html. - -For adding permission using the AWS CLI, see add-permission : https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html. +Specifies the configuration for AWS Lambda triggers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html @@ -47,14 +39,14 @@ For adding permission using the AWS CLI, see add-permission : https://docs.aws. UpdateType: Mutable .PARAMETER PreTokenGeneration - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + A Lambda trigger that is invoked before token generation. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration PrimitiveType: String UpdateType: Mutable .PARAMETER UserMigration - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The user migration Lambda config type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 index a7bcfc384..c10db2733 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolNumberAttributeConstraints.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolNumberAttributeConstraints { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.NumberAttributeConstraints resource property to the template. The NumberAttributeConstraints property type defines the number attribute constraints of an Amazon Cognito User Pool. NumberAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. + Adds an AWS::Cognito::UserPool.NumberAttributeConstraints resource property to the template. The minimum and maximum value of an attribute that is of the number data type. .DESCRIPTION Adds an AWS::Cognito::UserPool.NumberAttributeConstraints resource property to the template. -The NumberAttributeConstraints property type defines the number attribute constraints of an Amazon Cognito User Pool. NumberAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. +The minimum and maximum value of an attribute that is of the number data type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 index 6c6cdfff9..a9fca3969 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPasswordPolicy.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolPasswordPolicy { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.PasswordPolicy resource property to the template. PasswordPolicy is a subproperty of the Policies: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html property that defines the password policy of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.PasswordPolicy resource property to the template. The password policy type. .DESCRIPTION Adds an AWS::Cognito::UserPool.PasswordPolicy resource property to the template. -PasswordPolicy is a subproperty of the Policies: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html property that defines the password policy of an Amazon Cognito User Pool. +The password policy type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 index 0dd9873b0..1f880ef4d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolPolicies.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolPolicies { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.Policies resource property to the template. Policies is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the password policies of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.Policies resource property to the template. The policy associated with a user pool. .DESCRIPTION Adds an AWS::Cognito::UserPool.Policies resource property to the template. -Policies is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the password policies of an Amazon Cognito User Pool. +The policy associated with a user pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRecoveryOption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRecoveryOption.ps1 index 9ad93bd71..1788fc86a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRecoveryOption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRecoveryOption.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolRecoveryOption { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.RecoveryOption resource property to the template. + Adds an AWS::Cognito::UserPool.RecoveryOption resource property to the template. A map containing a priority as a key, and recovery method name as a value. .DESCRIPTION Adds an AWS::Cognito::UserPool.RecoveryOption resource property to the template. - +A map containing a priority as a key, and recovery method name as a value. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html .PARAMETER Priority + A positive integer specifying priority of a method with 1 being the highest priority. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name + Specifies the recovery method for a user. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolResourceServerResourceServerScopeType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolResourceServerResourceServerScopeType.ps1 index 21b643876..4be15ffbb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolResourceServerResourceServerScopeType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolResourceServerResourceServerScopeType.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolResourceServerResourceServerScopeType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType resource property to the template. + Adds an AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType resource property to the template. A resource server scope. .DESCRIPTION Adds an AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType resource property to the template. - +A resource server scope. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html .PARAMETER ScopeName + The name of the scope. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename PrimitiveType: String UpdateType: Mutable .PARAMETER ScopeDescription + A description of the scope. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType.ps1 index 3e89ea4ee..8b21ecb5a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType.ps1 @@ -1,21 +1,29 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType resource property to the template. Account takeover action type. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType resource property to the template. - +Account takeover action type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html .PARAMETER Notify + Flag specifying whether to send a notification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EventAction + The event action. ++ BLOCK Choosing this action will block the request. ++ MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request. ++ MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request. ++ NO_ACTION Allow the user sign-in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType.ps1 index e7ba1425c..eab73ece6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType.ps1 @@ -1,26 +1,32 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType resource property to the template. Account takeover actions type. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType resource property to the template. - +Account takeover actions type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html .PARAMETER HighAction + Action to take for a high risk. + Type: AccountTakeoverActionType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction UpdateType: Mutable .PARAMETER LowAction + Action to take for a low risk. + Type: AccountTakeoverActionType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction UpdateType: Mutable .PARAMETER MediumAction + Action to take for a medium risk. + Type: AccountTakeoverActionType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType.ps1 index 743dfbd90..75eab2ff6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType resource property to the template. Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType resource property to the template. - +Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html .PARAMETER Actions + Account takeover risk configuration actions + Type: AccountTakeoverActionsType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions UpdateType: Mutable .PARAMETER NotifyConfiguration + The notify configuration used to construct email notifications. + Type: NotifyConfigurationType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-notifyconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType.ps1 index 9b5218ca6..79bddfe07 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType resource property to the template. The compromised credentials actions type .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType resource property to the template. - +The compromised credentials actions type .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html .PARAMETER EventAction + The event action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype-eventaction PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType.ps1 index 5ebdd3b77..91f630bac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType.ps1 @@ -1,21 +1,25 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType resource property to the template. The compromised credentials risk configuration type. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType resource property to the template. - +The compromised credentials risk configuration type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html .PARAMETER Actions + The compromised credentials risk configuration actions. + Type: CompromisedCredentialsActionsType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-actions UpdateType: Mutable .PARAMETER EventFilter + Perform the action for these events. The default is to perform all events if no event filter is specified. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-eventfilter diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType.ps1 index ea9f49f4d..64d1a92ac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType.ps1 @@ -1,41 +1,53 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType resource property to the template. The notify configuration type. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType resource property to the template. - +The notify configuration type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html .PARAMETER BlockEmail + Email template used when a detected risk event is blocked. + Type: NotifyEmailType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail UpdateType: Mutable .PARAMETER ReplyTo + The destination to which the receiver of an email should reply to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto PrimitiveType: String UpdateType: Mutable .PARAMETER SourceArn + The Amazon Resource Name ARN of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-sourcearn PrimitiveType: String UpdateType: Mutable .PARAMETER NoActionEmail + The email template used when a detected risk event is allowed. + Type: NotifyEmailType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail UpdateType: Mutable .PARAMETER From + The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-from PrimitiveType: String UpdateType: Mutable .PARAMETER MfaEmail + The MFA email template used when MFA is challenged as part of a detected risk. + Type: NotifyEmailType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyEmailType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyEmailType.ps1 index 6752922d0..c09caa2c7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyEmailType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyEmailType.ps1 @@ -1,26 +1,32 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentNotifyEmailType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType resource property to the template. The notify email type. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType resource property to the template. - +The notify email type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html .PARAMETER TextBody + The text body. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-textbody PrimitiveType: String UpdateType: Mutable .PARAMETER HtmlBody + The HTML body. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-htmlbody PrimitiveType: String UpdateType: Mutable .PARAMETER Subject + The subject. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-subject PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType.ps1 index 0f1c77411..8c1ea0715 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType.ps1 @@ -1,22 +1,26 @@ function Add-VSCognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType resource property to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType resource property to the template. The type of the configuration to override the risk decision. .DESCRIPTION Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType resource property to the template. - +The type of the configuration to override the risk decision. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html .PARAMETER BlockedIPRangeList + Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-blockediprangelist UpdateType: Mutable .PARAMETER SkippedIPRangeList + Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-skippediprangelist diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 index fdd0f1e10..9b1983974 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSchemaAttribute.ps1 @@ -1,17 +1,18 @@ function Add-VSCognitoUserPoolSchemaAttribute { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.SchemaAttribute resource property to the template. SchemaAttribute is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the schema attributes of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.SchemaAttribute resource property to the template. Contains information about the schema attribute. .DESCRIPTION Adds an AWS::Cognito::UserPool.SchemaAttribute resource property to the template. -SchemaAttribute is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the schema attributes of an Amazon Cognito User Pool. +Contains information about the schema attribute. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html .PARAMETER DeveloperOnlyAttribute - Specifies whether the attribute type is developer only. + We recommend that you use WriteAttributes: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute. +Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 index 8e69c7b08..34ef4f8de 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolSmsConfiguration.ps1 @@ -1,25 +1,24 @@ function Add-VSCognitoUserPoolSmsConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.SmsConfiguration resource property to the template. SmsConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the SMS configuration of an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPool.SmsConfiguration resource property to the template. The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account. The Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role that you provide for your AWS account. .DESCRIPTION Adds an AWS::Cognito::UserPool.SmsConfiguration resource property to the template. -SmsConfiguration is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the SMS configuration of an Amazon Cognito User Pool. +The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account. The Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role that you provide for your AWS account. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html .PARAMETER ExternalId - The external ID used in IAM role trust relationships. -For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html in the *AWS Identity and Access Management User Guide*. + The external ID is a value. We recommend you use ExternalIdto add security to your IAM role, which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User Pool uses it when attempting to assume your IAM role. You can also set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito creates a role with the required permissions and a trust policy that uses ExternalId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-externalid PrimitiveType: String UpdateType: Mutable .PARAMETER SnsCallerArn - The Amazon Resource Name ARN of the Amazon Simple Notification Service SNS caller. + The Amazon Resource Name ARN of the Amazon Simple Notification Service SNS caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snscallerarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 index 762630132..beaf04dc7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolStringAttributeConstraints.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolStringAttributeConstraints { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.StringAttributeConstraints resource property to the template. The StringAttributeConstraints property type defines the string attribute constraints of an Amazon Cognito User Pool. StringAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. + Adds an AWS::Cognito::UserPool.StringAttributeConstraints resource property to the template. The StringAttributeConstraints property type defines the string attribute constraints of an Amazon Cognito user pool. StringAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. .DESCRIPTION Adds an AWS::Cognito::UserPool.StringAttributeConstraints resource property to the template. -The StringAttributeConstraints property type defines the string attribute constraints of an Amazon Cognito User Pool. StringAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. +The StringAttributeConstraints property type defines the string attribute constraints of an Amazon Cognito user pool. StringAttributeConstraints is a subproperty of the SchemaAttribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html property type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 index 6089992da..012b65245 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserAttributeType.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolUserAttributeType { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolUser.AttributeType resource property to the template. AttributeType is a property of the AWS::Cognito::UserPoolUser: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html resource that defines name-value pairs for a user in an Amazon Cognito User Pool. + Adds an AWS::Cognito::UserPoolUser.AttributeType resource property to the template. Specifies whether the attribute is standard or custom. .DESCRIPTION Adds an AWS::Cognito::UserPoolUser.AttributeType resource property to the template. -AttributeType is a property of the AWS::Cognito::UserPoolUser: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html resource that defines name-value pairs for a user in an Amazon Cognito User Pool. +Specifies whether the attribute is standard or custom. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 index ab99fed37..4cbcfa465 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUserPoolAddOns.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolUserPoolAddOns { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.UserPoolAddOns resource property to the template. UserPoolAddOns is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that enables advanced security risk detection. + Adds an AWS::Cognito::UserPool.UserPoolAddOns resource property to the template. The user pool add-ons type. .DESCRIPTION Adds an AWS::Cognito::UserPool.UserPoolAddOns resource property to the template. -UserPoolAddOns is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that enables advanced security risk detection. +The user pool add-ons type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUsernameConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUsernameConfiguration.ps1 index f3be05f24..d043d8de0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUsernameConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolUsernameConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSCognitoUserPoolUsernameConfiguration { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.UsernameConfiguration resource property to the template. + Adds an AWS::Cognito::UserPool.UsernameConfiguration resource property to the template. Used to configure username case insensitivity. .DESCRIPTION Adds an AWS::Cognito::UserPool.UsernameConfiguration resource property to the template. - +Used to configure username case insensitivity. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html .PARAMETER CaseSensitive + Set to False if you want username, email alias and preferred_username alias to be case insensitive. For example, when set to False, users will be able to sign in using either "username" or "Username". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html#cfn-cognito-userpool-usernameconfiguration-casesensitive PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 index dcba5b167..9011b129a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSCognitoUserPoolVerificationMessageTemplate.ps1 @@ -1,11 +1,11 @@ function Add-VSCognitoUserPoolVerificationMessageTemplate { <# .SYNOPSIS - Adds an AWS::Cognito::UserPool.VerificationMessageTemplate resource property to the template. VerificationMessageTemplate is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the template for verification messages. + Adds an AWS::Cognito::UserPool.VerificationMessageTemplate resource property to the template. The template for verification messages. .DESCRIPTION Adds an AWS::Cognito::UserPool.VerificationMessageTemplate resource property to the template. -VerificationMessageTemplate is a property of the AWS::Cognito::UserPool: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html resource that defines the template for verification messages. +The template for verification messages. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigConformancePackConformancePackInputParameter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigConformancePackConformancePackInputParameter.ps1 index 0051beaef..faa0f01d0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigConformancePackConformancePackInputParameter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigConformancePackConformancePackInputParameter.ps1 @@ -1,21 +1,25 @@ function Add-VSConfigConformancePackConformancePackInputParameter { <# .SYNOPSIS - Adds an AWS::Config::ConformancePack.ConformancePackInputParameter resource property to the template. + Adds an AWS::Config::ConformancePack.ConformancePackInputParameter resource property to the template. Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters. .DESCRIPTION Adds an AWS::Config::ConformancePack.ConformancePackInputParameter resource property to the template. - +Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html .PARAMETER ParameterName + One part of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html#cfn-config-conformancepack-conformancepackinputparameter-parametername UpdateType: Mutable PrimitiveType: String .PARAMETER ParameterValue + Another part of the key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html#cfn-config-conformancepack-conformancepackinputparameter-parametervalue UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConformancePackConformancePackInputParameter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConformancePackConformancePackInputParameter.ps1 index 43ffeb1a3..35bd5a951 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConformancePackConformancePackInputParameter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigOrganizationConformancePackConformancePackInputParameter.ps1 @@ -1,21 +1,25 @@ function Add-VSConfigOrganizationConformancePackConformancePackInputParameter { <# .SYNOPSIS - Adds an AWS::Config::OrganizationConformancePack.ConformancePackInputParameter resource property to the template. + Adds an AWS::Config::OrganizationConformancePack.ConformancePackInputParameter resource property to the template. Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters. .DESCRIPTION Adds an AWS::Config::OrganizationConformancePack.ConformancePackInputParameter resource property to the template. - +Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconformancepack-conformancepackinputparameter.html .PARAMETER ParameterName + One part of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconformancepack-conformancepackinputparameter.html#cfn-config-organizationconformancepack-conformancepackinputparameter-parametername UpdateType: Mutable PrimitiveType: String .PARAMETER ParameterValue + One part of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconformancepack-conformancepackinputparameter.html#cfn-config-organizationconformancepack-conformancepackinputparameter-parametervalue UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationExecutionControls.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationExecutionControls.ps1 index b8bbdebff..13bedf832 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationExecutionControls.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationExecutionControls.ps1 @@ -1,16 +1,18 @@ function Add-VSConfigRemediationConfigurationExecutionControls { <# .SYNOPSIS - Adds an AWS::Config::RemediationConfiguration.ExecutionControls resource property to the template. + Adds an AWS::Config::RemediationConfiguration.ExecutionControls resource property to the template. An ExecutionControls object. .DESCRIPTION Adds an AWS::Config::RemediationConfiguration.ExecutionControls resource property to the template. - +An ExecutionControls object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-executioncontrols.html .PARAMETER SsmControls + A SsmControls object. + Type: SsmControls Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-executioncontrols.html#cfn-config-remediationconfiguration-executioncontrols-ssmcontrols UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationSsmControls.ps1 b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationSsmControls.ps1 index 22a66f581..3d1e63521 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationSsmControls.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSConfigRemediationConfigurationSsmControls.ps1 @@ -1,21 +1,25 @@ function Add-VSConfigRemediationConfigurationSsmControls { <# .SYNOPSIS - Adds an AWS::Config::RemediationConfiguration.SsmControls resource property to the template. + Adds an AWS::Config::RemediationConfiguration.SsmControls resource property to the template. The SsmControls property type specifies Not currently supported by AWS CloudFormation. for an AWS::Config::RemediationConfiguration: aws-resource-config-remediationconfiguration.md. .DESCRIPTION Adds an AWS::Config::RemediationConfiguration.SsmControls resource property to the template. - +The SsmControls property type specifies Not currently supported by AWS CloudFormation. for an AWS::Config::RemediationConfiguration: aws-resource-config-remediationconfiguration.md. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html .PARAMETER ErrorPercentage + The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html#cfn-config-remediationconfiguration-ssmcontrols-errorpercentage PrimitiveType: Integer UpdateType: Mutable .PARAMETER ConcurrentExecutionRatePercentage + The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html#cfn-config-remediationconfiguration-ssmcontrols-concurrentexecutionratepercentage PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule.ps1 index 2e254e205..4958d4bac 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule.ps1 @@ -1,21 +1,25 @@ function Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule resource property to the template. Specifies the retention rule for cross-Region snapshot copies. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule resource property to the template. - +Specifies the retention rule for cross-Region snapshot copies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html .PARAMETER IntervalUnit + The unit of time for time-based retention. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyretainrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Interval + The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyretainrule-interval PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRule.ps1 index 43c685ae1..bdeac6e50 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyCrossRegionCopyRule.ps1 @@ -1,36 +1,46 @@ function Add-VSDLMLifecyclePolicyCrossRegionCopyRule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRule resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRule resource property to the template. Specifies a rule for cross-Region snapshot copies. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRule resource property to the template. - +Specifies a rule for cross-Region snapshot copies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html .PARAMETER TargetRegion + The target Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-targetregion PrimitiveType: String UpdateType: Mutable .PARAMETER Encrypted + To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CmkArn + The Amazon Resource Name ARN of the AWS KMS customer master key CMK to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-cmkarn PrimitiveType: String UpdateType: Mutable .PARAMETER RetainRule + The retention rule. + Type: CrossRegionCopyRetainRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-retainrule UpdateType: Mutable .PARAMETER CopyTags + Copy all user-defined tags from the source snapshot to the copied snapshot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-copytags PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyFastRestoreRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyFastRestoreRule.ps1 index c52b70064..897bd5ac6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyFastRestoreRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyFastRestoreRule.ps1 @@ -1,32 +1,40 @@ function Add-VSDLMLifecyclePolicyFastRestoreRule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.FastRestoreRule resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.FastRestoreRule resource property to the template. Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.FastRestoreRule resource property to the template. - +Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html .PARAMETER IntervalUnit + The unit of time for enabling fast snapshot restore. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER AvailabilityZones + The Availability Zones in which to enable fast snapshot restore. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-availabilityzones UpdateType: Mutable .PARAMETER Count + The number of snapshots to be enabled with fast snapshot restore. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Interval + The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-interval PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyParameters.ps1 index 415f3c5e3..5149089c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyParameters.ps1 @@ -1,16 +1,18 @@ function Add-VSDLMLifecyclePolicyParameters { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.Parameters resource property to the template. + Adds an AWS::DLM::LifecyclePolicy.Parameters resource property to the template. Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.Parameters resource property to the template. - +Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html .PARAMETER ExcludeBootVolume + EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html. The default is false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-excludebootvolume PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 index 26eb18b0f..51eae635e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyPolicyDetails.ps1 @@ -11,7 +11,7 @@ Specifies the configuration of a lifecycle policy. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html .PARAMETER ResourceTypes - The resource type. Specify one of INSTANCE or VOLUME. + The resource type. PrimitiveItemType: String Type: List @@ -27,14 +27,14 @@ Specifies the configuration of a lifecycle policy. UpdateType: Mutable .PARAMETER PolicyType - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policytype PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + A set of optional parameters for the policy. Type: Parameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-parameters @@ -81,16 +81,8 @@ Specifies the configuration of a lifecycle policy. $PolicyType, [parameter(Mandatory = $false)] $Parameters, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $true)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $TargetTags ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 index 55940f4fc..e8343f1cd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicyRetainRule.ps1 @@ -1,31 +1,31 @@ function Add-VSDLMLifecyclePolicyRetainRule { <# .SYNOPSIS - Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. Specifies the number of snapshots to keep for each EBS volume. + Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. -Specifies the number of snapshots to keep for each EBS volume. +Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html .PARAMETER IntervalUnit - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The unit of time for time-based retention. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Count - The number of snapshots to keep for each volume, up to a maximum of 1000. + The number of snapshots to retain for each volume, up to a maximum of 1000. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Interval - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-interval PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 index 1c134ddd9..2e395f54f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDLMLifecyclePolicySchedule.ps1 @@ -19,14 +19,14 @@ Specifies a backup schedule. UpdateType: Mutable .PARAMETER CreateRule - The create rule. + The creation rule. Type: CreateRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-createrule UpdateType: Mutable .PARAMETER VariableTags - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $instance-id or $timestamp. Variable tags are only valid for EBS Snapshot Management – Instance policies. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-variabletags @@ -34,21 +34,21 @@ Specifies a backup schedule. UpdateType: Mutable .PARAMETER FastRestoreRule - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The rule for enabling fast snapshot restore. Type: FastRestoreRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-fastrestorerule UpdateType: Mutable .PARAMETER RetainRule - The retain rule. + The retention rule. Type: RetainRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-retainrule UpdateType: Mutable .PARAMETER CrossRegionCopyRules - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The rule for cross-Region snapshot copies. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-crossregioncopyrules @@ -76,29 +76,13 @@ Specifies a backup schedule. [cmdletbinding()] Param ( + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $TagsToAdd, [parameter(Mandatory = $false)] $CreateRule, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $VariableTags, [parameter(Mandatory = $false)] $FastRestoreRule, diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 index 1cd7a5ed1..f554349b3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointElasticsearchSettings.ps1 @@ -45,7 +45,7 @@ ServiceAccessRoleArn: #cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolea EndpointUri -The endpoint for the ElasticSearch cluster. +The endpoint for the Elasticsearch cluster. *Required*: No diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 index 27a84b658..1d6de9a1b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointMongoDbSettings.ps1 @@ -77,7 +77,7 @@ The authentication mechanism you use to access the MongoDB source endpoint. Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 -DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No. +DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting is not used when authType=No. *Required*: No @@ -89,7 +89,7 @@ DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, us AuthSource -The MongoDB database name. This attribute is not used when authType=NO. +The MongoDB database name. This setting is not used when authType=NO. The default is admin. @@ -127,7 +127,7 @@ The database name on the MongoDB source endpoint. DocsToInvestigate -Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE. +Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to ONE. Must be a positive value greater than 0. Default value is 1000. @@ -139,7 +139,7 @@ Must be a positive value greater than 0. Default value is 1000. ExtractDocId -Specifies the document ID. Use this attribute when NestingLevel is set to NONE. +Specifies the document ID. Use this setting when NestingLevel is set to NONE. Default value is false. diff --git a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 index f5fd6e740..8b65c3f0d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDMSEndpointS3Settings.ps1 @@ -25,7 +25,7 @@ Settings for exporting data to Amazon S3. UpdateType: Mutable .PARAMETER BucketFolder - An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path ///. If this parameter is not specified, then the path used is //. + An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path bucketFolder/schema_name/table_name/. If this parameter is not specified, then the path used is schema_name/table_name/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketfolder PrimitiveType: String @@ -53,7 +53,7 @@ Settings for exporting data to Amazon S3. UpdateType: Mutable .PARAMETER CompressionType - An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE the default or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats. + An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE the default or do not use to leave the files uncompressed. Applies to both .csv and .parquet file formats. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-compressiontype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 index d0daa057e..5d2a89db1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableGlobalSecondaryIndex.ps1 @@ -21,7 +21,7 @@ Represents the properties of a global secondary index. The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + HASH - partition key + RANGE - sort key -The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. +The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-keyschema diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 index db5c8a483..32d8ad9fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableKeySchema.ps1 @@ -25,7 +25,7 @@ A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute The role that this key attribute will assume: + HASH - partition key + RANGE - sort key -The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. +The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-keytype diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 index 8d1a1e5f3..705f4d886 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableLocalSecondaryIndex.ps1 @@ -21,7 +21,7 @@ Represents the properties of a local secondary index. The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + HASH - partition key + RANGE - sort key -The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. +The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-keyschema diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 index fc2abde11..9d230edf1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableProjection.ps1 @@ -23,7 +23,7 @@ For local secondary indexes, the total count of NonKeyAttributes summed across a .PARAMETER ProjectionType The set of attributes that are projected into the index: + KEYS_ONLY - Only the index and primary keys are projected into the index. -+ INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ++ INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes. + ALL - All of the table attributes are projected into the index. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-projtype diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 index ff0855e57..530fd51ea 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableSSESpecification.ps1 @@ -11,7 +11,7 @@ Represents the settings used to enable server-side encryption. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html .PARAMETER KMSMasterKeyId - The KMS customer master key CMK that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name ARN, alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB customer master key alias/aws/dynamodb. + The AWS KMS customer master key CMK that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name ARN, alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB customer master key alias/aws/dynamodb. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-kmsmasterkeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 index 666c256c2..f16b58b10 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSDynamoDBTableTimeToLiveSpecification.ps1 @@ -1,24 +1,24 @@ function Add-VSDynamoDBTableTimeToLiveSpecification { <# .SYNOPSIS - Adds an AWS::DynamoDB::Table.TimeToLiveSpecification resource property to the template. Represents the settings used to enable or disable Time to Live for the specified table. + Adds an AWS::DynamoDB::Table.TimeToLiveSpecification resource property to the template. Represents the settings used to enable or disable Time to Live (TTL for the specified table. .DESCRIPTION Adds an AWS::DynamoDB::Table.TimeToLiveSpecification resource property to the template. -Represents the settings used to enable or disable Time to Live for the specified table. +Represents the settings used to enable or disable Time to Live (TTL for the specified table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html .PARAMETER AttributeName - The name of the Time to Live attribute used to store the expiration time for items in the table. + The name of the TTL attribute used to store the expiration time for items in the table. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-attributename PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled - Indicates whether Time To Live is to be enabled true or disabled false on the table. + Indicates whether TTL is to be enabled true or disabled false on the table. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-enabled PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 index d6816c8a3..fca5f7436 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2CapacityReservationTagSpecification.ps1 @@ -45,16 +45,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat } })] $ResourceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 index 183ada9e2..adc0ae3a5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2ClientVpnEndpointTagSpecification.ps1 @@ -43,16 +43,8 @@ The tags to apply to a resource when the resource is being created. } })] $ResourceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $true)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 index a097cdb96..0657490dc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateOverridesRequest.ps1 @@ -34,7 +34,7 @@ FleetLaunchTemplateOverridesRequest is a property of the FleetLaunchTemplateCon UpdateType: Mutable .PARAMETER SubnetId - The ID of the subnet in which to launch the instances. + The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas for example, subnet-1234abcdeexample1, subnet-0987cdef6example2. A request of type instant can have only one subnet ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-subnetid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 index 84201b513..d793021bf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetFleetLaunchTemplateSpecificationRequest.ps1 @@ -20,7 +20,7 @@ FleetLaunchTemplateSpecificationRequest is a property of the FleetLaunchTemplat UpdateType: Mutable .PARAMETER Version - The version number of the launch template. + The version number of the launch template. Note: This is a required parameter and will be updated soon. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-version PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 index 7d2d468b0..ed2398d1e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2EC2FleetSpotOptionsRequest.ps1 @@ -13,7 +13,11 @@ SpotOptionsRequest is a property of the AWS::EC2::EC2Fleet: https://docs.aws.am http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html .PARAMETER AllocationStrategy - Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice. + Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet. +If the allocation strategy is lowestPrice, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy. +If the allocation strategy is diversified, EC2 Fleet launches instances from all the Spot Instance pools that you specify. +If the allocation strategy is capacityOptimized, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity. +*Allowed Values*: lowestPrice | diversified | capacityOptimized Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-allocationstrategy PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 index f7c57c28c..eb98beb38 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceEbs.ps1 @@ -13,7 +13,7 @@ Ebs is a property of the Amazon EC2 BlockDeviceMapping: https://docs.aws.amazon http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html .PARAMETER DeleteOnTermination - Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination: url-doc-domain;AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination in the Amazon Elastic Compute Cloud User Guide. + Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination in the Amazon Elastic Compute Cloud User Guide. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-deleteontermination PrimitiveType: Boolean @@ -61,7 +61,7 @@ Constraints: 1-16384 for General Purpose SSD gp2, 4-16384 for Provisioned IOPS S UpdateType: Mutable .PARAMETER VolumeType - The volume type. If you set the type to io1, you must also specify the IOPS that the volume supports. + The volume type. If you set the type to io1, you must also specify the **Iops** parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the **Iops** parameter. Default: gp2 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumetype diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 index fb1c12c2e..776bb12eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticGpuSpecification.ps1 @@ -13,7 +13,7 @@ ElasticGpuSpecification is a property of the AWS::EC2::Instance: https://docs.aw http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html .PARAMETER Type - The type of Elastic Graphics accelerator. + The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics, specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 index e784733d4..d3593d762 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceElasticInferenceAccelerator.ps1 @@ -13,14 +13,14 @@ ElasticInferenceAccelerator is a property of the AWS::EC2::Instance: https://doc http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html .PARAMETER Count - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The number of elastic inference accelerators to attach to the instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Type - The type of elastic inference accelerator. The possible values are eia1.small, eia1.medium, and eia1.large. + The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceHibernationOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceHibernationOptions.ps1 index 4d61ee468..dc615e0c0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceHibernationOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceHibernationOptions.ps1 @@ -1,16 +1,21 @@ function Add-VSEC2InstanceHibernationOptions { <# .SYNOPSIS - Adds an AWS::EC2::Instance.HibernationOptions resource property to the template. + Adds an AWS::EC2::Instance.HibernationOptions resource property to the template. Specifies the hibernation options for the instance. .DESCRIPTION Adds an AWS::EC2::Instance.HibernationOptions resource property to the template. +Specifies the hibernation options for the instance. +HibernationOptions is a property of the AWS::EC2::Instance: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html .PARAMETER Configured + If you set this parameter to true, your instance is enabled for hibernation. +Default: false + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html#cfn-ec2-instance-hibernationoptions-configured PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 index d12d326aa..9c000f5d8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2InstanceNetworkInterface.ps1 @@ -13,7 +13,7 @@ NetworkInterface is a property of the AWS::EC2::Instance: https://docs.aws.amazo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html .PARAMETER AssociatePublicIpAddress - Whether or not to associates a public IPv4 address with eth0. + Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-associatepubip PrimitiveType: Boolean @@ -68,6 +68,7 @@ If you specify a network interface when launching an instance, you must specify .PARAMETER NetworkInterfaceId The ID of the network interface. +If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-network-iface PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 index 03f8638cc..d76cdde0a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateEbs.ps1 @@ -27,7 +27,7 @@ Ebs is a property of the Amazon EC2 LaunchTemplate BlockDeviceMapping: https:// UpdateType: Mutable .PARAMETER KmsKeyId - The ARN of the AWS Key Management Service AWS KMS CMK used for encryption. + The ARN of the symmetric AWS Key Management Service AWS KMS CMK used for encryption. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-kmskeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 index bc789ddf2..208e6df8c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateElasticGpuSpecification.ps1 @@ -13,7 +13,7 @@ ElasticGpuSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTe http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html .PARAMETER Type - The type of Elastic Graphics accelerator. + The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics, specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html#cfn-ec2-launchtemplate-elasticgpuspecification-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 index 3b0d80e3f..542f10861 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateData.ps1 @@ -87,7 +87,7 @@ We recommend that you use PV-GRUB instead of kernels and RAM disks. For more inf UpdateType: Mutable .PARAMETER NetworkInterfaces - One or more network interfaces. If you specify a network interface, you must specify any security groups as part of the network interface. + One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces @@ -116,14 +116,14 @@ We recommend that you use PV-GRUB instead of kernels and RAM disks. For more inf UpdateType: Mutable .PARAMETER HibernationOptions - Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html in the *Amazon Elastic Compute Cloud User Guide*. + Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites. For more information, see Hibernate Your Instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html in the *Amazon Elastic Compute Cloud User Guide*. Type: HibernationOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions UpdateType: Mutable .PARAMETER MetadataOptions - + RequestLaunchTemplateData: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html in the *Amazon Elastic Compute Cloud API Reference* + The metadata options for the instance. For more information, see Instance Metadata and User Data: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html in the *Amazon Elastic Compute Cloud User Guide*. Type: MetadataOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 index a8f2c16ab..050221e1c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateLaunchTemplateElasticInferenceAccelerator.ps1 @@ -20,7 +20,8 @@ LaunchTemplateElasticInferenceAccelerator is a property of the Amazon EC2 Launch UpdateType: Mutable .PARAMETER Count - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The number of elastic inference accelerators to attach to the instance. +Default: 1 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-count PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMetadataOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMetadataOptions.ps1 index 8491cdba6..a77e1a951 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMetadataOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateMetadataOptions.ps1 @@ -1,26 +1,39 @@ function Add-VSEC2LaunchTemplateMetadataOptions { <# .SYNOPSIS - Adds an AWS::EC2::LaunchTemplate.MetadataOptions resource property to the template. + Adds an AWS::EC2::LaunchTemplate.MetadataOptions resource property to the template. Specifies the metadata options for the instance. .DESCRIPTION Adds an AWS::EC2::LaunchTemplate.MetadataOptions resource property to the template. +Specifies the metadata options for the instance. +MetadataOptions is a property of the AWS::EC2::LaunchTemplate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html .PARAMETER HttpPutResponseHopLimit + The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. +Default: 1 +Possible values: Integers from 1 to 64 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpputresponsehoplimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER HttpTokens + The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional. +If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned. +If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens PrimitiveType: String UpdateType: Mutable .PARAMETER HttpEndpoint + This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled. +If you specify a value of disabled, you will not be able to access your instance metadata. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpendpoint PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 index ca96abcff..a0ce5d753 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplatePlacement.ps1 @@ -27,14 +27,14 @@ Placement is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: htt UpdateType: Mutable .PARAMETER SpreadDomain - + LaunchTemplatePlacementRequest: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplatePlacementRequest.html in the *Amazon Elastic Compute Cloud API Reference* + Reserved for future use. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-spreaddomain PrimitiveType: String UpdateType: Mutable .PARAMETER PartitionNumber - + LaunchTemplatePlacementRequest: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplatePlacementRequest.html in the *Amazon Elastic Compute Cloud API Reference* + The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-partitionnumber PrimitiveType: Integer @@ -62,7 +62,7 @@ Placement is a property of the Amazon EC2 LaunchTemplate LaunchTemplateData: htt UpdateType: Mutable .PARAMETER HostResourceGroupArn - + LaunchTemplatePlacementRequest: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplatePlacementRequest.html in the *Amazon Elastic Compute Cloud API Reference* + The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the **Tenancy** parameter or set it to host. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostresourcegrouparn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 index ece789a39..8ea592bd1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateSpotOptions.ps1 @@ -14,6 +14,7 @@ SpotOptions is a property of the Amazon EC2 LaunchTemplate InstanceMarketOptions .PARAMETER SpotInstanceType The Spot Instance request type. +If you are using Spot Instances with an Auto Scaling group, use one-time requests, as the Amazon EC2 Auto Scaling service handles requesting new Spot Instances whenever the group is below its desired capacity. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-spotinstancetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 index a428b239b..9d2b976f5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LaunchTemplateTagSpecification.ps1 @@ -45,16 +45,8 @@ TagSpecification is a property of the Amazon EC2 LaunchTemplate LaunchTemplateDa } })] $ResourceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2LocalGatewayRouteTableVPCAssociationTags.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2LocalGatewayRouteTableVPCAssociationTags.ps1 index 5205ee05c..5aad163f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2LocalGatewayRouteTableVPCAssociationTags.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2LocalGatewayRouteTableVPCAssociationTags.ps1 @@ -1,16 +1,18 @@ function Add-VSEC2LocalGatewayRouteTableVPCAssociationTags { <# .SYNOPSIS - Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation.Tags resource property to the template. + Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation.Tags resource property to the template. The tags assigned to the association. .DESCRIPTION Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation.Tags resource property to the template. - +The tags assigned to the association. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-localgatewayroutetablevpcassociation-tags.html .PARAMETER Tags + The tags assigned to the association. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-localgatewayroutetablevpcassociation-tags.html#cfn-ec2-localgatewayroutetablevpcassociation-tags-tags UpdateType: Mutable Type: List @@ -24,16 +26,8 @@ function Add-VSEC2LocalGatewayRouteTableVPCAssociationTags { [cmdletbinding()] Param ( + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 index cad616eee..2176036b3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupEgress.ps1 @@ -15,7 +15,7 @@ The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGro http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html .PARAMETER CidrIp - The IPv4 address range, in CIDR format. + The destination IPv4 address range, in CIDR format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip PrimitiveType: String @@ -23,7 +23,7 @@ The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGro .PARAMETER CidrIpv6 EC2-VPC only] The IPv6 ranges. -The IPv6 address range, in CIDR format. +The destination IPv6 address range, in CIDR format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6 PrimitiveType: String @@ -38,7 +38,7 @@ Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0- UpdateType: Mutable .PARAMETER DestinationPrefixListId - EC2-VPC only] The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. + EC2-VPC only] The prefix list IDs for the destination AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destinationprefixlistid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 index 055b2cf48..ec6427a98 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SecurityGroupIngress.ps1 @@ -15,7 +15,7 @@ The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGro http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html .PARAMETER CidrIp - The IPv4 address range, in CIDR format. + The destination IPv4 address range, in CIDR format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip PrimitiveType: String @@ -23,7 +23,7 @@ The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGro .PARAMETER CidrIpv6 EC2-VPC only] The IPv6 ranges. -The IPv6 address range, in CIDR format. +The destination IPv6 address range, in CIDR format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6 PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 index 661810eda..48872bdb6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetEbsBlockDevice.ps1 @@ -11,16 +11,17 @@ Describes a block device for an EBS volume. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html .PARAMETER DeleteOnTermination - Indicates whether the EBS volume is deleted on instance termination. + Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination in the Amazon Elastic Compute Cloud User Guide. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Encrypted - Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The default effect of setting the Encrypted parameter to true through the console, API, or CLI depends on the volume's origin new or from a snapshot, starting encryption state, ownership, and whether account-level encryption: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/account-level-encryption.html is enabled. Each default case can be overridden by specifying a customer master key CMK with the KmsKeyId parameter in addition to setting Encrypted to true. For a complete list of possible encryption cases, see Amazon EBS Encryption: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters in the *Amazon Elastic Compute Cloud User Guide*. + Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin new or from a snapshot, starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters in the *Amazon Elastic Compute Cloud User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances. +This parameter is not returned by DescribeImageAttribute: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted PrimitiveType: Boolean @@ -52,8 +53,8 @@ Constraints: 1-16384 for General Purpose SSD gp2, 4-16384 for Provisioned IOPS S UpdateType: Mutable .PARAMETER VolumeType - The volume type. If you set the type to io1, you must also set the **Iops** property. -Default: standard + The volume type. If you set the type to io1, you must also specify the **Iops** parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the **Iops** parameter. +Default: gp2 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 index 48af293d6..135b7def8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetInstanceNetworkInterfaceSpecification.ps1 @@ -66,6 +66,7 @@ If you specify a network interface when launching an instance, you must specify .PARAMETER NetworkInterfaceId The ID of the network interface. +If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid PrimitiveType: String @@ -88,7 +89,7 @@ If you specify a network interface when launching an instance, you must specify UpdateType: Mutable .PARAMETER SubnetId - The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance. + The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 index a87254fa0..55799b132 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetLaunchSpecification.ps1 @@ -11,7 +11,7 @@ Specifies the launch specification for one or more Spot Instances. If you includ http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html .PARAMETER BlockDeviceMappings - One or more block devices that are mapped to the Spot instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. + One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings DuplicatesAllowed: False @@ -109,7 +109,7 @@ Default: false UpdateType: Mutable .PARAMETER SubnetId - The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08". + The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2". Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 index af641e303..0d7a898d1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetRequestConfigData.ps1 @@ -13,7 +13,10 @@ You must specify either LaunchSpecifications or LaunchTemplateConfigs. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html .PARAMETER AllocationStrategy - Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice. + Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request. +If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy. +If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify. +If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy PrimitiveType: String @@ -41,7 +44,7 @@ You must specify either LaunchSpecifications or LaunchTemplateConfigs. UpdateType: Immutable .PARAMETER LaunchSpecifications - The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs. + The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications DuplicatesAllowed: False @@ -50,7 +53,7 @@ You must specify either LaunchSpecifications or LaunchTemplateConfigs. UpdateType: Immutable .PARAMETER LaunchTemplateConfigs - The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs. + The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchtemplateconfigs DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 index 2995d6f90..6358528a2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2SpotFleetSpotFleetTagSpecification.ps1 @@ -11,7 +11,7 @@ The tags for a Spot Fleet resource. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html .PARAMETER ResourceType - The type of resource. Currently, the only resource type that is supported is instance. + The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData : https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype PrimitiveType: String @@ -44,16 +44,8 @@ The tags for a Spot Fleet resource. } })] $ResourceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags ) Begin { diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2TrafficMirrorFilterRuleTrafficMirrorPortRange.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2TrafficMirrorFilterRuleTrafficMirrorPortRange.ps1 index 8a04eb631..829e1c2dc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2TrafficMirrorFilterRuleTrafficMirrorPortRange.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2TrafficMirrorFilterRuleTrafficMirrorPortRange.ps1 @@ -1,21 +1,25 @@ function Add-VSEC2TrafficMirrorFilterRuleTrafficMirrorPortRange { <# .SYNOPSIS - Adds an AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange resource property to the template. + Adds an AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange resource property to the template. Describes the Traffic Mirror port range. .DESCRIPTION Adds an AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange resource property to the template. - +Describes the Traffic Mirror port range. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html .PARAMETER FromPort + The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-fromport PrimitiveType: Integer UpdateType: Mutable .PARAMETER ToPort + The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-toport PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 index f65cbc9b6..3230f33ef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification.ps1 @@ -1,18 +1,18 @@ function Add-VSEC2VPNConnectionVpnTunnelOptionsSpecification { <# .SYNOPSIS - Adds an AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification resource property to the template. The tunnel options for a VPN connection. + Adds an AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification resource property to the template. The tunnel options for a single VPN tunnel. .DESCRIPTION Adds an AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification resource property to the template. -The tunnel options for a VPN connection. +The tunnel options for a single VPN tunnel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html .PARAMETER PreSharedKey The pre-shared key PSK to establish initial authentication between the virtual private gateway and customer gateway. -Constraints: Allowed characters are alphanumeric characters and ._. Must be between 8 and 64 characters in length and cannot start with zero 0. +Constraints: Allowed characters are alphanumeric characters, periods ., and underscores _. Must be between 8 and 64 characters in length and cannot start with zero 0. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSClusterClusterSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSClusterClusterSetting.ps1 index 5969a5ab8..66c067e17 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSClusterClusterSetting.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSClusterClusterSetting.ps1 @@ -1,21 +1,25 @@ function Add-VSECSClusterClusterSetting { <# .SYNOPSIS - Adds an AWS::ECS::Cluster.ClusterSetting resource property to the template. + Adds an AWS::ECS::Cluster.ClusterSetting resource property to the template. The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. .DESCRIPTION Adds an AWS::ECS::Cluster.ClusterSetting resource property to the template. - +The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersetting.html .PARAMETER Name + The name of the cluster setting. The only supported value is containerInsights. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersetting.html#cfn-ecs-cluster-clustersetting-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value + The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html or PutAccountSettingDefault: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersetting.html#cfn-ecs-cluster-clustersetting-value PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 index fba71fa9b..032a13bf3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSECSServiceDeploymentConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deploymentand the ordering of stopping and starting tasks. + Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. .DESCRIPTION Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. -The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deploymentand the ordering of stopping and starting tasks. +The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentController.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentController.ps1 index dee456e2b..e3d619b81 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentController.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceDeploymentController.ps1 @@ -1,16 +1,25 @@ function Add-VSECSServiceDeploymentController { <# .SYNOPSIS - Adds an AWS::ECS::Service.DeploymentController resource property to the template. + Adds an AWS::ECS::Service.DeploymentController resource property to the template. The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::Service.DeploymentController resource property to the template. - +The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html .PARAMETER Type + The deployment controller type to use. +There are three deployment controller types available: +ECS +The rolling update ECS deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html. +CODE_DEPLOY +The blue/green CODE_DEPLOY deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. +EXTERNAL +The external EXTERNAL deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html#cfn-ecs-service-deploymentcontroller-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 index cfa56ead3..beb33a89e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServiceLoadBalancer.ps1 @@ -24,22 +24,26 @@ Services with tasks that use the awsvpc network mode (for example, those with th UpdateType: Immutable .PARAMETER ContainerPort - The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping. + The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-containerport PrimitiveType: Integer UpdateType: Immutable .PARAMETER LoadBalancerName - The name of the load balancer to associate with the Amazon ECS service. + The name of the load balancer to associate with the Amazon ECS service or task set. +A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-loadbalancername PrimitiveType: String UpdateType: Immutable .PARAMETER TargetGroupArn - The full Amazon Resource Name ARN of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. -If your service's task definition uses the awsvpc network mode which is required for the Fargate launch type, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. + The full Amazon Resource Name ARN of the Elastic Load Balancing target group or groups associated with a service or task set. +A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted. +For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the *Amazon Elastic Container Service Developer Guide*. +For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the *Amazon Elastic Container Service Developer Guide*. +If your service's task definition uses the awsvpc network mode which is required for the Fargate launch type, you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-targetgrouparn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 index fb899882d..0f557e7c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSServicePlacementConstraint.ps1 @@ -18,7 +18,7 @@ The PlacementConstraint property specifies an object representing a constraint o UpdateType: Immutable .PARAMETER Type - The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions. + The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 index a3be2a068..fd6e70847 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDefinition.ps1 @@ -23,7 +23,6 @@ The ContainerDefinition property specifies a container definition. Container def The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cpu-shares option to docker run: https://docs.docker.com/engine/reference/run/. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances: http://aws.amazon.com/ec2/instance-types/ detail page by 1,024. -For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-cpu @@ -33,7 +32,7 @@ Linux containers share unallocated CPU units with other containers on the contai .PARAMETER DependsOn The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. -This parameter is available for tasks using the Fargate launch type in the Ohio us-east-2 region only and the task or service requires platform version 1.3.0 or later. +For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dependson DuplicatesAllowed: False @@ -80,9 +79,9 @@ This parameter is not supported for Windows containers. .PARAMETER DockerSecurityOptions A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type. +With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to SecurityOpt in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --security-opt option to docker run: https://docs.docker.com/engine/reference/run/. The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html in the *Amazon Elastic Container Service Developer Guide*. -This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockersecurityoptions DuplicatesAllowed: False @@ -129,7 +128,7 @@ This parameter is not supported for Windows containers or tasks that use the aws UpdateType: Immutable .PARAMETER FirelensConfiguration - *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-firelensconfiguration Type: FirelensConfiguration @@ -301,16 +300,17 @@ This parameter is not supported for Windows containers. .PARAMETER StartTimeout Time duration in seconds to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state. -For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. -This parameter is available for tasks using the Fargate launch type in the Ohio us-east-2 region only and the task or service requires platform version 1.3.0 or later. +For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. If this parameter is not specified, the default value of 3 minutes is used. +For tasks using the EC2 launch type, if the startTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_START_TIMEOUT is used by default. If neither the startTimeout parameter or the ECS_CONTAINER_START_TIMEOUT agent configuration variable are set, then the default values of 3 minutes for Linux containers and 8 minutes on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-starttimeout PrimitiveType: Integer UpdateType: Immutable .PARAMETER StopTimeout - Time duration in seconds to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the max stopTimeout value is 2 minutes. This parameter is available for tasks using the Fargate launch type in the Ohio us-east-2 region only and the task or service requires platform version 1.3.0 or later. -For tasks using the EC2 launch type, the stop timeout value for the container takes precedence over the ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used. Container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. + Time duration in seconds to wait before the container is forcefully killed if it doesn't exit normally on its own. +For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. +For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-stoptimeout PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 index 035571394..62b0a2a90 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionContainerDependency.ps1 @@ -11,7 +11,7 @@ Your Amazon ECS container instances require at least version 1.26.0 of the conta **Note** -If you are using tasks that use the Fargate launch type, container dependency parameters are not supported. +For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 index 5e3635420..b8dcd8a2a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionDockerVolumeConfiguration.ps1 @@ -19,14 +19,14 @@ This field is only used if the scope is shared. UpdateType: Immutable .PARAMETER Driver - The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery. This parameter maps to Driver in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxdriver option to docker volume create : https://docs.docker.com/engine/reference/commandline/volume_create/. + The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery. This parameter maps to Driver in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxdriver option to docker volume create: https://docs.docker.com/engine/reference/commandline/volume_create/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driver PrimitiveType: String UpdateType: Immutable .PARAMETER DriverOpts - A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxopt option to docker volume create : https://docs.docker.com/engine/reference/commandline/volume_create/. + A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxopt option to docker volume create: https://docs.docker.com/engine/reference/commandline/volume_create/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driveropts DuplicatesAllowed: False @@ -35,7 +35,7 @@ This field is only used if the scope is shared. UpdateType: Immutable .PARAMETER Labels - Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxlabel option to docker volume create : https://docs.docker.com/engine/reference/commandline/volume_create/. + Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxlabel option to docker volume create: https://docs.docker.com/engine/reference/commandline/volume_create/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-labels DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionFirelensConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionFirelensConfiguration.ps1 index ada42ae08..878005dc0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionFirelensConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionFirelensConfiguration.ps1 @@ -1,16 +1,22 @@ function Add-VSECSTaskDefinitionFirelensConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.FirelensConfiguration resource property to the template. + Adds an AWS::ECS::TaskDefinition.FirelensConfiguration resource property to the template. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.FirelensConfiguration resource property to the template. - +The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html .PARAMETER Options + The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. +If specified, valid option keys are: ++ enable-ecs-log-metadata, which can be true or false ++ config-file-type, which can be s3 or file ++ config-file-value, which is either an S3 ARN or a file path + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-options DuplicatesAllowed: False PrimitiveItemType: String @@ -18,6 +24,8 @@ function Add-VSECSTaskDefinitionFirelensConfiguration { UpdateType: Immutable .PARAMETER Type + The log router to use. The valid values are fluentd or fluentbit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-type PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionInferenceAccelerator.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionInferenceAccelerator.ps1 index 1c1b423e8..581d5ec1d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionInferenceAccelerator.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionInferenceAccelerator.ps1 @@ -1,26 +1,32 @@ function Add-VSECSTaskDefinitionInferenceAccelerator { <# .SYNOPSIS - Adds an AWS::ECS::TaskDefinition.InferenceAccelerator resource property to the template. + Adds an AWS::ECS::TaskDefinition.InferenceAccelerator resource property to the template. Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.InferenceAccelerator resource property to the template. - +Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html .PARAMETER DeviceName + The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicename PrimitiveType: String UpdateType: Immutable .PARAMETER DevicePolicy + *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicepolicy PrimitiveType: String UpdateType: Immutable .PARAMETER DeviceType + The Elastic Inference accelerator type to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicetype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 index 6379c2b5b..0639d5596 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLinuxParameters.ps1 @@ -36,7 +36,9 @@ If you are using tasks that use the Fargate launch type, the devices parameter i UpdateType: Immutable .PARAMETER MaxSwap - *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + The total amount of swap memory in MiB a container can use. This parameter will be translated to the --memory-swap option to docker run: https://docs.docker.com/engine/reference/run/ where the value would be the sum of the container memory plus the maxSwap value. +If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used. +If you are using tasks that use the Fargate launch type, the maxSwap parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-maxswap PrimitiveType: Integer @@ -51,7 +53,8 @@ If you are using tasks that use the Fargate launch type, the sharedMemorySize pa UpdateType: Immutable .PARAMETER Swappiness - *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run: https://docs.docker.com/engine/reference/run/. +If you are using tasks that use the Fargate launch type, the swappiness parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-swappiness PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 index f1b96412e..6af8ed6b6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionLogConfiguration.ps1 @@ -11,12 +11,12 @@ The LogConfiguration property specifies log configuration options to send to a c http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html .PARAMETER LogDriver - The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. -For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk. -For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. + The log driver to use for the container. The valid values listed earlier are log drivers that the Amazon ECS container agent can communicate with by default. +For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens. +For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens. For more information about using the awslogs log driver, see Using the awslogs Log Driver: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html in the *Amazon Elastic Container Service Developer Guide*. -If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub: https://github.com/aws/amazon-ecs-agent and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software. -This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' +For more information about using the awsfirelens log driver, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. +If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub: https://github.com/aws/amazon-ecs-agent and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-logdriver PrimitiveType: String @@ -32,7 +32,7 @@ This parameter requires version 1.18 of the Docker Remote API or greater on your UpdateType: Immutable .PARAMETER SecretOptions - The secrets to pass to the log configuration. + The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-secretoptions DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 index 99d524965..c7afb5eb6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionResourceRequirement.ps1 @@ -11,14 +11,16 @@ The ResourceRequirement property specifies the type and amount of a resource to http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html .PARAMETER Type - The type of resource to assign to a container. The only supported value is GPU. + The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-type PrimitiveType: String UpdateType: Immutable .PARAMETER Value - The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on. + The value for the specified resource type. +If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on. +If the InferenceAccelerator type is used, the value should match the DeviceName for an InferenceAccelerator: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html specified in a task definition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-value PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 index 81228b057..3a49bed57 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint.ps1 @@ -22,7 +22,7 @@ For more information, see Task Placement Constraints: https://docs.aws.amazon.co UpdateType: Immutable .PARAMETER Type - The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates. + The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 index 9322c2cd5..0733187d9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskDefinitionVolume.ps1 @@ -11,7 +11,7 @@ The Volume property specifies a data volume used in a task definition. For tasks http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html .PARAMETER DockerVolumeConfiguration - This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. + This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volume-dockervolumeconfiguration Type: DockerVolumeConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetAwsVpcConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetAwsVpcConfiguration.ps1 index cf604b9f9..01d826cd6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetAwsVpcConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetAwsVpcConfiguration.ps1 @@ -1,27 +1,35 @@ function Add-VSECSTaskSetAwsVpcConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::TaskSet.AwsVpcConfiguration resource property to the template. + Adds an AWS::ECS::TaskSet.AwsVpcConfiguration resource property to the template. The networking details for a task. .DESCRIPTION Adds an AWS::ECS::TaskSet.AwsVpcConfiguration resource property to the template. - +The networking details for a task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html .PARAMETER AssignPublicIp + Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-assignpublicip UpdateType: Immutable PrimitiveType: String .PARAMETER SecurityGroups + The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. +All specified security groups must be from the same VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-securitygroups UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Subnets + The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. +All specified subnets must be from the same VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-subnets UpdateType: Immutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetLoadBalancer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetLoadBalancer.ps1 index d10340908..db80dde38 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetLoadBalancer.ps1 @@ -1,31 +1,44 @@ function Add-VSECSTaskSetLoadBalancer { <# .SYNOPSIS - Adds an AWS::ECS::TaskSet.LoadBalancer resource property to the template. + Adds an AWS::ECS::TaskSet.LoadBalancer resource property to the template. Details on the load balancer or load balancers to use with a task set. .DESCRIPTION Adds an AWS::ECS::TaskSet.LoadBalancer resource property to the template. - +Details on the load balancer or load balancers to use with a task set. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html .PARAMETER ContainerName + The name of the container as it appears in a container definition to associate with the load balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerPort + The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER LoadBalancerName + The name of the load balancer to associate with the Amazon ECS service or task set. +A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-loadbalancername UpdateType: Immutable PrimitiveType: String .PARAMETER TargetGroupArn + The full Amazon Resource Name ARN of the Elastic Load Balancing target group or groups associated with a service or task set. +A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted. +For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the *Amazon Elastic Container Service Developer Guide*. +For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the *Amazon Elastic Container Service Developer Guide*. +If your service's task definition uses the awsvpc network mode which is required for the Fargate launch type, you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-targetgrouparn UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetNetworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetNetworkConfiguration.ps1 index 2c75c9ae6..3fdb68211 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetNetworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetNetworkConfiguration.ps1 @@ -1,16 +1,19 @@ function Add-VSECSTaskSetNetworkConfiguration { <# .SYNOPSIS - Adds an AWS::ECS::TaskSet.NetworkConfiguration resource property to the template. + Adds an AWS::ECS::TaskSet.NetworkConfiguration resource property to the template. The network configuration for a task. .DESCRIPTION Adds an AWS::ECS::TaskSet.NetworkConfiguration resource property to the template. - +The network configuration for a task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html .PARAMETER AwsVpcConfiguration + The VPC subnets and security groups associated with a task. +All specified subnets and security groups must be from the same VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html#cfn-ecs-taskset-networkconfiguration-awsvpcconfiguration UpdateType: Immutable Type: AwsVpcConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetScale.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetScale.ps1 index db6359d47..06c0afd5c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetScale.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetScale.ps1 @@ -1,21 +1,25 @@ function Add-VSECSTaskSetScale { <# .SYNOPSIS - Adds an AWS::ECS::TaskSet.Scale resource property to the template. + Adds an AWS::ECS::TaskSet.Scale resource property to the template. A floating-point percentage of the desired number of tasks to place and keep running in the task set. .DESCRIPTION Adds an AWS::ECS::TaskSet.Scale resource property to the template. - +A floating-point percentage of the desired number of tasks to place and keep running in the task set. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html .PARAMETER Unit + The unit of measure for the scale value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-unit UpdateType: Mutable PrimitiveType: String .PARAMETER Value + The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-value UpdateType: Mutable PrimitiveType: Double diff --git a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetServiceRegistry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetServiceRegistry.ps1 index df4c5e825..b5c7be3d7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetServiceRegistry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSECSTaskSetServiceRegistry.ps1 @@ -1,31 +1,39 @@ function Add-VSECSTaskSetServiceRegistry { <# .SYNOPSIS - Adds an AWS::ECS::TaskSet.ServiceRegistry resource property to the template. + Adds an AWS::ECS::TaskSet.ServiceRegistry resource property to the template. Details of the service registry. .DESCRIPTION Adds an AWS::ECS::TaskSet.ServiceRegistry resource property to the template. - +Details of the service registry. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html .PARAMETER ContainerName + The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerPort + The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER Port + The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-port UpdateType: Immutable PrimitiveType: Integer .PARAMETER RegistryArn + The Amazon Resource Name ARN of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-registryarn UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemLifecyclePolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemLifecyclePolicy.ps1 index b7bee72a8..dd56cc48e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemLifecyclePolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEFSFileSystemLifecyclePolicy.ps1 @@ -1,16 +1,18 @@ function Add-VSEFSFileSystemLifecyclePolicy { <# .SYNOPSIS - Adds an AWS::EFS::FileSystem.LifecyclePolicy resource property to the template. + Adds an AWS::EFS::FileSystem.LifecyclePolicy resource property to the template. Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA storage class. .DESCRIPTION Adds an AWS::EFS::FileSystem.LifecyclePolicy resource property to the template. - +Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA storage class. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticfilesystem-filesystem-lifecyclepolicy.html .PARAMETER TransitionToIA + A value that describes the period of time that a file is not accessed, after which it transitions to the IA storage class. Metadata operations such as listing the contents of a directory don't count as file access events. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticfilesystem-filesystem-lifecyclepolicy.html#cfn-elasticfilesystem-filesystem-lifecyclepolicy-transitiontoia PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupRemoteAccess.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupRemoteAccess.ps1 index 7a5ccc7f9..44fd1e4f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupRemoteAccess.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupRemoteAccess.ps1 @@ -1,22 +1,26 @@ function Add-VSEKSNodegroupRemoteAccess { <# .SYNOPSIS - Adds an AWS::EKS::Nodegroup.RemoteAccess resource property to the template. + Adds an AWS::EKS::Nodegroup.RemoteAccess resource property to the template. An object representing the remote access configuration for the managed node group. .DESCRIPTION Adds an AWS::EKS::Nodegroup.RemoteAccess resource property to the template. - +An object representing the remote access configuration for the managed node group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html .PARAMETER SourceSecurityGroups + The security groups that are allowed SSH access port 22 to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet 0.0.0.0/0. For more information, see Security Groups for Your VPC: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html in the *Amazon Virtual Private Cloud User Guide*. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html#cfn-eks-nodegroup-remoteaccess-sourcesecuritygroups UpdateType: Immutable .PARAMETER Ec2SshKey + The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html#cfn-eks-nodegroup-remoteaccess-ec2sshkey PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupScalingConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupScalingConfig.ps1 index 7d966faf5..32ab4770c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupScalingConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEKSNodegroupScalingConfig.ps1 @@ -1,26 +1,32 @@ function Add-VSEKSNodegroupScalingConfig { <# .SYNOPSIS - Adds an AWS::EKS::Nodegroup.ScalingConfig resource property to the template. + Adds an AWS::EKS::Nodegroup.ScalingConfig resource property to the template. An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. .DESCRIPTION Adds an AWS::EKS::Nodegroup.ScalingConfig resource property to the template. - +An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html .PARAMETER MinSize + The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html#cfn-eks-nodegroup-scalingconfig-minsize PrimitiveType: Double UpdateType: Mutable .PARAMETER DesiredSize + The current number of worker nodes that the managed node group should maintain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html#cfn-eks-nodegroup-scalingconfig-desiredsize PrimitiveType: Double UpdateType: Mutable .PARAMETER MaxSize + The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html#cfn-eks-nodegroup-scalingconfig-maxsize PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 index 41f88215e..e6bd83bc6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterCloudWatchAlarmDefinition.ps1 @@ -27,7 +27,7 @@ CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which UpdateType: Mutable .PARAMETER EvaluationPeriods - The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. + The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-evaluationperiods PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 index 16b1fe115..bb3888004 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterInstanceGroupConfig.ps1 @@ -18,8 +18,7 @@ Use InstanceGroupConfig to define instance groups for an EMR cluster. A cluster UpdateType: Mutable .PARAMETER BidPrice - The maximum Spot price your are willing to pay for EC2 instances. -If BidPrice is specified, Amazon EMR uses Spot Instances for the instance group. Specified in USD. Alternatively, a value of OnDemandPrice indicates that the maximum Spot price is set equal to the On-Demand price. + The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-bidprice PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 index 9e8c9c062..4ea48b8c1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterJobFlowInstancesConfig.ps1 @@ -50,8 +50,7 @@ JobFlowInstancesConfig is a property of the AWS::EMR::Cluster resource. JobFlowI UpdateType: Immutable .PARAMETER Ec2SubnetId - Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches. -Amazon VPC currently does not support cluster compute quadruple extra large cc1.4xlarge instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC. + Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2subnetid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 index 31abf843e..00c7b38b5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRClusterStepConfig.ps1 @@ -11,7 +11,7 @@ StepConfig is a property of the AWS::EMR::Cluster resource. The StepConfig prope http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html .PARAMETER ActionOnFailure - The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + The action to take when the cluster step fails. Possible values are CANCEL_AND_WAIT and CONTINUE. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-actiononfailure PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 index 02f8773d2..d4cf65084 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEMRInstanceGroupConfigCloudWatchAlarmDefinition.ps1 @@ -27,7 +27,7 @@ CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which UpdateType: Mutable .PARAMETER EvaluationPeriods - The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. + The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-evaluationperiods PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 index 0d6d9ced5..4c2809de0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticBeanstalkApplicationApplicationResourceLifecycleConfig.ps1 @@ -14,6 +14,7 @@ ApplicationResourceLifecycleConfig is a property of the AWS::ElasticBeanstalk::A .PARAMETER ServiceRole The ARN of an IAM service role that Elastic Beanstalk has permission to assume. +The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-servicerole PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 index 1e58f6a90..3659f4d2e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerAction.ps1 @@ -32,15 +32,13 @@ Specifies an action for a listener rule. UpdateType: Mutable .PARAMETER ForwardConfig - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig Type: ForwardConfig UpdateType: Mutable .PARAMETER Order - The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a forward or a fixed-response action. - Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-order PrimitiveType: Integer UpdateType: Mutable @@ -53,14 +51,14 @@ Specifies an action for a listener rule. UpdateType: Mutable .PARAMETER TargetGroupArn - The Amazon Resource Name ARN of the target group. Specify only when Type is forward. + The Amazon Resource Name ARN of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-targetgrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Type - The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect. + The type of action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerForwardConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerForwardConfig.ps1 index 023cf6c9b..5dc8dbf93 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerForwardConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerForwardConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerForwardConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.ForwardConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.ForwardConfig resource property to the template. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.ForwardConfig resource property to the template. - +Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html .PARAMETER TargetGroupStickinessConfig + Information about the target group stickiness for a rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroupstickinessconfig Type: TargetGroupStickinessConfig UpdateType: Mutable .PARAMETER TargetGroups + Information about how traffic will be distributed between multiple target groups in a forward rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroups DuplicatesAllowed: False ItemType: TargetGroupTuple diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 index a9bcf1ded..aebf640c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleAction.ps1 @@ -32,15 +32,13 @@ Specifies an action for a listener rule. UpdateType: Mutable .PARAMETER ForwardConfig - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-forwardconfig Type: ForwardConfig UpdateType: Mutable .PARAMETER Order - The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a forward or a fixed-response action. - Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-order PrimitiveType: Integer UpdateType: Mutable @@ -53,14 +51,14 @@ Specifies an action for a listener rule. UpdateType: Mutable .PARAMETER TargetGroupArn - The Amazon Resource Name ARN of the target group. Specify only when Type is forward. + The Amazon Resource Name ARN of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-targetgrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Type - The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect. + The type of action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleForwardConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleForwardConfig.ps1 index 44a4265b7..68254c1f2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleForwardConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleForwardConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerRuleForwardConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig resource property to the template. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig resource property to the template. - +Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html .PARAMETER TargetGroupStickinessConfig + Information about the target group stickiness for a rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html#cfn-elasticloadbalancingv2-listenerrule-forwardconfig-targetgroupstickinessconfig Type: TargetGroupStickinessConfig UpdateType: Mutable .PARAMETER TargetGroups + Information about how traffic will be distributed between multiple target groups in a forward rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html#cfn-elasticloadbalancingv2-listenerrule-forwardconfig-targetgroups DuplicatesAllowed: False ItemType: TargetGroupTuple diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig.ps1 index fdca8d1f4..65ccdefd7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig resource property to the template. Information about the target group stickiness for a rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig resource property to the template. - +Information about the target group stickiness for a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html .PARAMETER DurationSeconds + The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig-durationseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER Enabled + Indicates whether target group stickiness is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple.ps1 index c23ac5ce4..93c342faa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple resource property to the template. Information about how traffic will be distributed between multiple target groups in a forward rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple resource property to the template. - +Information about how traffic will be distributed between multiple target groups in a forward rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html .PARAMETER TargetGroupArn + The Amazon Resource Name ARN of the target group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html#cfn-elasticloadbalancingv2-listenerrule-targetgrouptuple-targetgrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Weight + The weight. The range is 0 to 999. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html#cfn-elasticloadbalancingv2-listenerrule-targetgrouptuple-weight PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig.ps1 index b1461c938..d23711bba 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig resource property to the template. Information about the target group stickiness for a rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig resource property to the template. - +Information about the target group stickiness for a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html .PARAMETER DurationSeconds + The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds 7 days. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-durationseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER Enabled + Indicates whether target group stickiness is enabled. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupTuple.ps1 index bc8d68e54..e03f7ff0c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2ListenerTargetGroupTuple.ps1 @@ -1,21 +1,25 @@ function Add-VSElasticLoadBalancingV2ListenerTargetGroupTuple { <# .SYNOPSIS - Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple resource property to the template. + Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple resource property to the template. Information about how traffic will be distributed between multiple target groups in a forward rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple resource property to the template. - +Information about how traffic will be distributed between multiple target groups in a forward rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html .PARAMETER TargetGroupArn + The Amazon Resource Name ARN of the target group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-targetgrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Weight + The weight. The range is 0 to 999. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-weight PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 index 3271c04b6..7f87a083c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute.ps1 @@ -19,7 +19,8 @@ The following attributes are supported by both Application Load Balancers and Ne + deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. The following attributes are supported by only Application Load Balancers: + idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. -+ routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. ++ routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer true or routed to targets false. The default is false. ++ routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. The following attributes are supported by only Network Load Balancers: + load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false. diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 index 9534bf0ae..c6b187908 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping.ps1 @@ -11,7 +11,7 @@ Specifies a subnet to attach to an Application Load Balancer or a Network Load B http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html .PARAMETER AllocationId - Network Load Balancers] The allocation ID of the Elastic IP address. + Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-allocationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 index 588b28cc1..5c2191bbf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetDescription.ps1 @@ -29,7 +29,7 @@ If the target type is lambda, this parameter is optional and the only supported UpdateType: Mutable .PARAMETER Port - The port on which the target is listening. + The port on which the target is listening. Not used if the target is a Lambda function. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-port PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 index 5cfb6bd9f..df2b3ddb9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute.ps1 @@ -15,6 +15,7 @@ Specifies a target group attribute. The following attribute is supported by both Application Load Balancers and Network Load Balancers: + deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. The following attributes are supported by Application Load Balancers if the target is not a Lambda function: ++ load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin. + slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds 15 minutes. Slow start mode is disabled by default. + stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false. + stickiness.type - The type of sticky sessions. The possible value is lb_cookie. diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainCognitoOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainCognitoOptions.ps1 index 82c307efc..b32a71495 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainCognitoOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainCognitoOptions.ps1 @@ -1,31 +1,39 @@ function Add-VSElasticsearchDomainCognitoOptions { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.CognitoOptions resource property to the template. + Adds an AWS::Elasticsearch::Domain.CognitoOptions resource property to the template. Configures Amazon ES to use Amazon Cognito authentication for Kibana. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.CognitoOptions resource property to the template. - +Configures Amazon ES to use Amazon Cognito authentication for Kibana. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html .PARAMETER Enabled + Whether to enable or disable Amazon Cognito authentication for Kibana. See Amazon Cognito Authentication for Kibana: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IdentityPoolId + The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-identitypoolid PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The AmazonESCognitoAccess role that allows Amazon ES to configure your user pool and identity pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId + The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-userpoolid PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 index a86f8e254..183177e85 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainElasticsearchClusterConfig.ps1 @@ -46,7 +46,7 @@ The cluster configuration for the Amazon ES domain. You can specify options such UpdateType: Mutable .PARAMETER ZoneAwarenessConfig - Specifies zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. + Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessconfig Type: ZoneAwarenessConfig diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainLogPublishingOption.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainLogPublishingOption.ps1 index 1d7c24026..fdaf7f15f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainLogPublishingOption.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainLogPublishingOption.ps1 @@ -1,21 +1,26 @@ function Add-VSElasticsearchDomainLogPublishingOption { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.LogPublishingOption resource property to the template. + Adds an AWS::Elasticsearch::Domain.LogPublishingOption resource property to the template. Specifies whether the Amazon ES domain publishes the Elasticsearch application and slow logs to Amazon CloudWatch. You still have to enable the *collection* of slow logs using the Elasticsearch REST API. To learn more, see Setting Elasticsearch Logging Thresholds for Slow Logs: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-slow-logs-indices. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.LogPublishingOption resource property to the template. - +Specifies whether the Amazon ES domain publishes the Elasticsearch application and slow logs to Amazon CloudWatch. You still have to enable the *collection* of slow logs using the Elasticsearch REST API. To learn more, see Setting Elasticsearch Logging Thresholds for Slow Logs: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-slow-logs-indices. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html .PARAMETER CloudWatchLogsLogGroupArn + Specifies the CloudWatch log group to publish to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-cloudwatchlogsloggrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled + If true, enables the publishing of logs to CloudWatch. +Default: false. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-enabled PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 index 3933aa909..f89c9ea1a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainVPCOptions.ps1 @@ -20,7 +20,7 @@ The virtual private cloud (VPC configuration for the Amazon ES domain. For more UpdateType: Mutable .PARAMETER SubnetIds - A list of subnet IDs that are associated with the VPC endpoints for the domain. If your domain has zone awareness enabled, you need to provide two subnet IDs, one per zone. Otherwise, provide only one. To learn more, see VPCs and Subnets: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html in the *Amazon VPC User Guide*. + Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see VPCs and Subnets: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html in the *Amazon VPC User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 index a65fc2f33..5f597c778 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSElasticsearchDomainZoneAwarenessConfig.ps1 @@ -1,18 +1,18 @@ function Add-VSElasticsearchDomainZoneAwarenessConfig { <# .SYNOPSIS - Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. Specifies zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. + Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. -Specifies zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. +Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html .PARAMETER AvailabilityZoneCount If you enabled multiple Availability Zones AZs, the number of AZs that you want the domain to use. -Valid values are 2 and 3. +Valid values are 2 and 3. Default is 2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventSchemasDiscovererTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventSchemasDiscovererTagsEntry.ps1 index 1a53f0dc4..3a07dc998 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventSchemasDiscovererTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventSchemasDiscovererTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSEventSchemasDiscovererTagsEntry { <# .SYNOPSIS - Adds an AWS::EventSchemas::Discoverer.TagsEntry resource property to the template. + Adds an AWS::EventSchemas::Discoverer.TagsEntry resource property to the template. Tags to associate with the discoverer. .DESCRIPTION Adds an AWS::EventSchemas::Discoverer.TagsEntry resource property to the template. - +Tags to associate with the discoverer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html .PARAMETER Value + They value of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html#cfn-eventschemas-discoverer-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + They key of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html#cfn-eventschemas-discoverer-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventSchemasRegistryTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventSchemasRegistryTagsEntry.ps1 index ca21785ef..8d96e7e39 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventSchemasRegistryTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventSchemasRegistryTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSEventSchemasRegistryTagsEntry { <# .SYNOPSIS - Adds an AWS::EventSchemas::Registry.TagsEntry resource property to the template. + Adds an AWS::EventSchemas::Registry.TagsEntry resource property to the template. Tags to associate with the schema registry. .DESCRIPTION Adds an AWS::EventSchemas::Registry.TagsEntry resource property to the template. - +Tags to associate with the schema registry. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html .PARAMETER Value + They value of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html#cfn-eventschemas-registry-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + They key of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html#cfn-eventschemas-registry-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventSchemasSchemaTagsEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventSchemasSchemaTagsEntry.ps1 index 79ae9f5c8..32ee13daf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventSchemasSchemaTagsEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventSchemasSchemaTagsEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSEventSchemasSchemaTagsEntry { <# .SYNOPSIS - Adds an AWS::EventSchemas::Schema.TagsEntry resource property to the template. + Adds an AWS::EventSchemas::Schema.TagsEntry resource property to the template. Tags to associate with the schema. .DESCRIPTION Adds an AWS::EventSchemas::Schema.TagsEntry resource property to the template. - +Tags to associate with the schema. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html .PARAMETER Value + They value of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html#cfn-eventschemas-schema-tagsentry-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + They key of a key-value pair. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html#cfn-eventschemas-schema-tagsentry-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 index 3281b8b78..8cf2e3ecf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleAwsVpcConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSEventsRuleAwsVpcConfiguration { <# .SYNOPSIS - Adds an AWS::Events::Rule.AwsVpcConfiguration resource property to the template. This structure specifies the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. + Adds an AWS::Events::Rule.AwsVpcConfiguration resource property to the template. This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. .DESCRIPTION Adds an AWS::Events::Rule.AwsVpcConfiguration resource property to the template. -This structure specifies the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. +This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html @@ -18,7 +18,7 @@ This structure specifies the VPC subnets and security groups for the task and wh UpdateType: Mutable .PARAMETER SecurityGroups - Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you don't specify a security group, the default security group for the VPC is used. + Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchArrayProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchArrayProperties.ps1 index f5ed3df01..0d595f2af 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchArrayProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchArrayProperties.ps1 @@ -1,16 +1,18 @@ function Add-VSEventsRuleBatchArrayProperties { <# .SYNOPSIS - Adds an AWS::Events::Rule.BatchArrayProperties resource property to the template. + Adds an AWS::Events::Rule.BatchArrayProperties resource property to the template. The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job. .DESCRIPTION Adds an AWS::Events::Rule.BatchArrayProperties resource property to the template. - +The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html .PARAMETER Size + The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchParameters.ps1 index e6756c5d2..a085bdccd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchParameters.ps1 @@ -1,31 +1,39 @@ function Add-VSEventsRuleBatchParameters { <# .SYNOPSIS - Adds an AWS::Events::Rule.BatchParameters resource property to the template. + Adds an AWS::Events::Rule.BatchParameters resource property to the template. The custom parameters to be used when the target is an AWS Batch job. .DESCRIPTION Adds an AWS::Events::Rule.BatchParameters resource property to the template. - +The custom parameters to be used when the target is an AWS Batch job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html .PARAMETER ArrayProperties + The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties Type: BatchArrayProperties UpdateType: Mutable .PARAMETER JobDefinition + The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition PrimitiveType: String UpdateType: Mutable .PARAMETER JobName + The name to use for this execution of the job, if the target is an AWS Batch job. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname PrimitiveType: String UpdateType: Mutable .PARAMETER RetryStrategy + The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy Type: BatchRetryStrategy UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchRetryStrategy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchRetryStrategy.ps1 index dfd0bcfaa..df8234d86 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchRetryStrategy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleBatchRetryStrategy.ps1 @@ -1,16 +1,18 @@ function Add-VSEventsRuleBatchRetryStrategy { <# .SYNOPSIS - Adds an AWS::Events::Rule.BatchRetryStrategy resource property to the template. + Adds an AWS::Events::Rule.BatchRetryStrategy resource property to the template. The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition. .DESCRIPTION Adds an AWS::Events::Rule.BatchRetryStrategy resource property to the template. - +The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html .PARAMETER Attempts + The number of times to attempt to retry, if the job fails. Valid values are 1–10. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 index 6e598dbfa..41642257b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleEcsParameters.ps1 @@ -13,7 +13,7 @@ EcsParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudF http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html .PARAMETER Group - Specifies an ECS task group for the task. The maximum length is 255 characters. + Specifies an ECS task group for the task. The maximum length is 255 characters. For more information, see Task Groups: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#task-groups. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group PrimitiveType: String @@ -27,15 +27,15 @@ EcsParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudF UpdateType: Mutable .PARAMETER NetworkConfiguration - Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. -If you specify NetworkConfiguration when the target ECS task doesn't use the awsvpc network mode, the task fails. + Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. +If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration Type: NetworkConfiguration UpdateType: Mutable .PARAMETER PlatformVersion - Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. + Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. If you omit this, the latest platform version is used. This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 index 53e0f6289..e820e9f51 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleInputTransformer.ps1 @@ -1,11 +1,11 @@ function Add-VSEventsRuleInputTransformer { <# .SYNOPSIS - Adds an AWS::Events::Rule.InputTransformer resource property to the template. The InputTransformer property type specifies settings that provide custom input to an Amazon CloudWatch Events target based on certain event data. + Adds an AWS::Events::Rule.InputTransformer resource property to the template. The InputTransformer property type specifies settings that provide custom input to an EventBridge target based on certain event data. .DESCRIPTION Adds an AWS::Events::Rule.InputTransformer resource property to the template. -The InputTransformer property type specifies settings that provide custom input to an Amazon CloudWatch Events target based on certain event data. +The InputTransformer property type specifies settings that provide custom input to an EventBridge target based on certain event data. InputTransformer is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 index 26a9c8f30..48bedba4e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleNetworkConfiguration.ps1 @@ -11,7 +11,7 @@ This structure specifies the network configuration for an ECS task. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html .PARAMETER AwsVpcConfiguration - Use this structure to specify the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. + Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration Type: AwsVpcConfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 index 487208eae..7c7115a2a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleRunCommandParameters.ps1 @@ -1,11 +1,11 @@ function Add-VSEventsRuleRunCommandParameters { <# .SYNOPSIS - Adds an AWS::Events::Rule.RunCommandParameters resource property to the template. The RunCommandParameters property type specifies the parameters to use when an Amazon CloudWatch Events rule invokes the AWS Systems Manager Run Command. + Adds an AWS::Events::Rule.RunCommandParameters resource property to the template. The RunCommandParameters property type specifies the parameters to use when a rule invokes the AWS Systems Manager Run Command. .DESCRIPTION Adds an AWS::Events::Rule.RunCommandParameters resource property to the template. -The RunCommandParameters property type specifies the parameters to use when an Amazon CloudWatch Events rule invokes the AWS Systems Manager Run Command. +The RunCommandParameters property type specifies the parameters to use when a rule invokes the AWS Systems Manager Run Command. RunCommandParameters is a property of the Target: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html property type. diff --git a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 index bdf8d5bd6..f87d2f222 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSEventsRuleTarget.ps1 @@ -1,13 +1,13 @@ function Add-VSEventsRuleTarget { <# .SYNOPSIS - Adds an AWS::Events::Rule.Target resource property to the template. The Target property type specifies a target, such as an AWS Lambda function or an Amazon Kinesis data stream, that CloudWatch Events invokes when a rule is triggered. + Adds an AWS::Events::Rule.Target resource property to the template. The Target property type specifies a target, such as an AWS Lambda function or an Amazon Kinesis data stream, that EventBridge invokes when a rule is triggered. .DESCRIPTION Adds an AWS::Events::Rule.Target resource property to the template. -The Target property type specifies a target, such as an AWS Lambda function or an Amazon Kinesis data stream, that CloudWatch Events invokes when a rule is triggered. +The Target property type specifies a target, such as an AWS Lambda function or an Amazon Kinesis data stream, that EventBridge invokes when a rule is triggered. -Targets property of the AWS::Events::Rule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html resource contains a list of one or more Target property types. +The Targets property of the AWS::Events::Rule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html resource contains a list of one or more Target property types. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html @@ -20,6 +20,8 @@ Targets property of the AWS::Events::Rule: https://docs.aws.amazon.com/AWSCloudF UpdateType: Mutable .PARAMETER BatchParameters + If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs: https://docs.aws.amazon.com/batch/latest/userguide/jobs.html in the *AWS Batch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters Type: BatchParameters UpdateType: Mutable @@ -32,7 +34,8 @@ Targets property of the AWS::Events::Rule: https://docs.aws.amazon.com/AWSCloudF UpdateType: Mutable .PARAMETER Id - The ID of the target. It can include alphanumeric characters, periods ., hyphens -, and underscores _. + A name for the target. Use a string that will help you identify the target. Each target associated with a rule must have an Id unique for that rule. +The Id can include alphanumeric characters, periods ., hyphens -, and underscores _. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id PrimitiveType: String @@ -68,6 +71,7 @@ Targets property of the AWS::Events::Rule: https://docs.aws.amazon.com/AWSCloudF .PARAMETER RoleArn The Amazon Resource Name ARN of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target. +If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions here in this parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyIEMap.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyIEMap.ps1 index 07ff2d70d..380aff7ec 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyIEMap.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyIEMap.ps1 @@ -1,16 +1,20 @@ function Add-VSFMSPolicyIEMap { <# .SYNOPSIS - Adds an AWS::FMS::Policy.IEMap resource property to the template. + Adds an AWS::FMS::Policy.IEMap resource property to the template. Specifies the AWS account IDs to exclude from or include in the policy. Used for the policy's IncludeMap and ExcludeMap. .DESCRIPTION Adds an AWS::FMS::Policy.IEMap resource property to the template. +Specifies the AWS account IDs to exclude from or include in the policy. Used for the policy's IncludeMap and ExcludeMap. +The key to the map is ACCOUNT. For example, a valid IEMap would be {“ACCOUNT” : “accountID1”, “accountID2”]}. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html .PARAMETER ACCOUNT + The account list for the map. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html#cfn-fms-policy-iemap-account UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyPolicyTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyPolicyTag.ps1 index 1825bf81f..91cec9c70 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyPolicyTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyPolicyTag.ps1 @@ -1,21 +1,25 @@ function Add-VSFMSPolicyPolicyTag { <# .SYNOPSIS - Adds an AWS::FMS::Policy.PolicyTag resource property to the template. + Adds an AWS::FMS::Policy.PolicyTag resource property to the template. A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment" and the tag value represents a specific value within that category (such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. .DESCRIPTION Adds an AWS::FMS::Policy.PolicyTag resource property to the template. - +A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment" and the tag value represents a specific value within that category (such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policytag.html .PARAMETER Key + Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policytag.html#cfn-fms-policy-policytag-key UpdateType: Mutable PrimitiveType: String .PARAMETER Value + Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policytag.html#cfn-fms-policy-policytag-value UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyResourceTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyResourceTag.ps1 index 9426a2d1a..1c04134dd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyResourceTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFMSPolicyResourceTag.ps1 @@ -1,21 +1,25 @@ function Add-VSFMSPolicyResourceTag { <# .SYNOPSIS - Adds an AWS::FMS::Policy.ResourceTag resource property to the template. + Adds an AWS::FMS::Policy.ResourceTag resource property to the template. The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor: https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html. .DESCRIPTION Adds an AWS::FMS::Policy.ResourceTag resource property to the template. - +The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor: https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html .PARAMETER Key + The resource tag key. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html#cfn-fms-policy-resourcetag-key UpdateType: Mutable PrimitiveType: String .PARAMETER Value + The resource tag value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html#cfn-fms-policy-resourcetag-value UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 index a9f4d21d0..70b308859 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemLustreConfiguration.ps1 @@ -11,7 +11,7 @@ The configuration for the Amazon FSx for Lustre file system. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html .PARAMETER ImportPath - The path to the Amazon S3 bucket including the optional prefix that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. + Optional The path to the Amazon S3 bucket including the optional prefix that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importpath PrimitiveType: String @@ -25,7 +25,7 @@ The configuration for the Amazon FSx for Lustre file system. UpdateType: Mutable .PARAMETER ImportedFileChunkSize - For files imported from a data repository, this value determines the stripe count and maximum amount of data per file in MiB stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. + Optional For files imported from a data repository, this value determines the stripe count and maximum amount of data per file in MiB stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The chunk size default is 1,024 MiB 1 GiB and can go as high as 512,000 MiB 500 GiB. Amazon S3 objects have a maximum size of 5 TB. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importedfilechunksize @@ -33,14 +33,14 @@ The chunk size default is 1,024 MiB 1 GiB and can go as high as 512,000 MiB 500 UpdateType: Immutable .PARAMETER DeploymentType - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Not currently supported by AWS CloudFormation. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-deploymenttype PrimitiveType: String UpdateType: Immutable .PARAMETER ExportPath - The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustrecreation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z. + Optional The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustrecreation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z. The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-exportpath @@ -48,7 +48,7 @@ The Amazon S3 export bucket must be the same as the import bucket specified by I UpdateType: Immutable .PARAMETER PerUnitStorageThroughput - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Not currently supported by AWS CloudFormation. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-perunitstoragethroughput PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemSelfManagedActiveDirectoryConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemSelfManagedActiveDirectoryConfiguration.ps1 index 6d5c4ade2..73a8b81a3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemSelfManagedActiveDirectoryConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemSelfManagedActiveDirectoryConfiguration.ps1 @@ -1,42 +1,60 @@ function Add-VSFSxFileSystemSelfManagedActiveDirectoryConfiguration { <# .SYNOPSIS - Adds an AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration resource property to the template. + Adds an AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration resource property to the template. The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises Microsoft Active Directory (AD directory. .DESCRIPTION Adds an AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration resource property to the template. - +The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises Microsoft Active Directory (AD directory. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html .PARAMETER FileSystemAdministratorsGroup + Optional The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls audit ACLs on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup PrimitiveType: String UpdateType: Immutable .PARAMETER UserName + The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-username PrimitiveType: String UpdateType: Mutable .PARAMETER DomainName + The fully qualified domain name of the self-managed AD directory, such as corp.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER OrganizationalUnitDistinguishedName + Optional The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253: https://tools.ietf.org/html/rfc2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. +Only Organizational Unit OU objects can be the direct parent of the file system that you're creating. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname PrimitiveType: String UpdateType: Immutable .PARAMETER DnsIps + A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 IPv4 address ranges, as specified in RFC 1918: http://www.faqs.org/rfcs/rfc1918.html: ++ 10.0.0.0 - 10.255.255.255 10/8 prefix ++ 172.16.0.0 - 172.31.255.255 172.16/12 prefix ++ 192.168.0.0 - 192.168.255.255 192.168/16 prefix + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-dnsips UpdateType: Mutable .PARAMETER Password + The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. We strongly suggest that you follow best practices and *do not* embed passwords in your CFN templates. +The recommended approach is to use AWS Secrets Manager to store your passwords. You can retrieve them for use in your templates using the secretsmanager dynamic reference. There are additional costs associated with using AWS Secrets Manager. To learn more, see Secrets Manager Secrets: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager in the *AWS CloudFormation User Guide*. +Alternatively, you can use the NoEcho property to obfuscate the password parameter value. For more information, see Do Not Embed Credentials in Your Templates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds in the *AWS CloudFormation User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-password PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 index 2f7bc79e1..4f4d27ba3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSFSxFileSystemWindowsConfiguration.ps1 @@ -1,59 +1,62 @@ function Add-VSFSxFileSystemWindowsConfiguration { <# .SYNOPSIS - Adds an AWS::FSx::FileSystem.WindowsConfiguration resource property to the template. The configuration for this Microsoft Windows file system. + Adds an AWS::FSx::FileSystem.WindowsConfiguration resource property to the template. The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS. .DESCRIPTION Adds an AWS::FSx::FileSystem.WindowsConfiguration resource property to the template. -The configuration for this Microsoft Windows file system. +The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html .PARAMETER SelfManagedActiveDirectoryConfiguration - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed including on-premises Microsoft Active Directory AD directory. Type: SelfManagedActiveDirectoryConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration UpdateType: Mutable .PARAMETER WeeklyMaintenanceStartTime - The preferred start time to perform weekly maintenance, in the UTC time zone. + The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-weeklymaintenancestarttime PrimitiveType: String UpdateType: Mutable .PARAMETER ActiveDirectoryId - The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. + The ID for an existing AWS Managed Microsoft Active Directory AD instance that the file system should join when it's created. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-activedirectoryid PrimitiveType: String UpdateType: Immutable .PARAMETER DeploymentType - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Specifies the file system deployment type, valid values are the following: ++ MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone AZ unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. ++ SINGLE_AZ_1 - Default Choose to deploy a file system that is configured for single AZ redundancy. +To learn more about high availability Multi-AZ file systems, see High Availability for Amazon FSx for Windows File Server: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-deploymenttype PrimitiveType: String UpdateType: Immutable .PARAMETER ThroughputCapacity - The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 8 and 2^11 2048. + The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the *n*th increments, between 2^3 8 and 2^11 2048. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-throughputcapacity PrimitiveType: Integer UpdateType: Immutable .PARAMETER CopyTagsToBackups - A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. + A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-copytagstobackups PrimitiveType: Boolean UpdateType: Immutable .PARAMETER DailyAutomaticBackupStartTime - The preferred time to take daily automatic backups, in the UTC time zone. + The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-dailyautomaticbackupstarttime PrimitiveType: String @@ -67,7 +70,7 @@ The configuration for this Microsoft Windows file system. UpdateType: Mutable .PARAMETER PreferredSubnetId - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your clients in the same Availability Zone AZ as your preferred file server to reduce cross-AZ data transfer costs and minimize latency. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-preferredsubnetid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 index bb81b8883..f8f3cd6a8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftAliasRoutingStrategy.ps1 @@ -1,36 +1,34 @@ function Add-VSGameLiftAliasRoutingStrategy { <# .SYNOPSIS - Adds an AWS::GameLift::Alias.RoutingStrategy resource property to the template. Routing configuration for a fleet alias. + Adds an AWS::GameLift::Alias.RoutingStrategy resource property to the template. The routing configuration for a fleet alias. .DESCRIPTION Adds an AWS::GameLift::Alias.RoutingStrategy resource property to the template. -Routing configuration for a fleet alias. +The routing configuration for a fleet alias. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html .PARAMETER FleetId - Unique identifier for a fleet that the alias points to. -*Required:* Conditional. If you specify SIMPLE for the Type property, you must specify this property. + A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid PrimitiveType: String UpdateType: Mutable .PARAMETER Message - Message text to be used with a terminal routing strategy. -*Required:* Conditional. If you specify TERMINAL for the Type property, you must specify this property. + The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message PrimitiveType: String UpdateType: Mutable .PARAMETER Type - Type of routing strategy. + A type of routing strategy. Possible routing types include the following: -+ **SIMPLE** -- The alias resolves to one specific fleet. Use this type when routing to active fleets. -+ **TERMINAL** -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message that you specified in the Message property. ++ **SIMPLE** - The alias resolves to one specific fleet. Use this type when routing to active fleets. ++ **TERMINAL** - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message that you specified in the Message property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 index c1edb46e0..f430a2c52 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftBuildS3Location.ps1 @@ -1,38 +1,38 @@ function Add-VSGameLiftBuildS3Location { <# .SYNOPSIS - Adds an AWS::GameLift::Build.S3Location resource property to the template. Location in Amazon Simple Storage Service (Amazon S3 where build files can be stored for access by Amazon GameLift. For more details, see the Uploading a Build to Amazon GameLift: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html in the *Amazon GameLift Developer Guide*. + Adds an AWS::GameLift::Build.S3Location resource property to the template. The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. .DESCRIPTION Adds an AWS::GameLift::Build.S3Location resource property to the template. -Location in Amazon Simple Storage Service (Amazon S3 where build files can be stored for access by Amazon GameLift. For more details, see the Uploading a Build to Amazon GameLift: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html in the *Amazon GameLift Developer Guide*. +The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html .PARAMETER Bucket - Amazon S3 bucket identifier. This is the name of the S3 bucket. + An S3 bucket identifier. This is the name of the S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-bucket PrimitiveType: String UpdateType: Immutable .PARAMETER Key - Name of the zip file containing the build files or script files. + The name of the zip file that contains the build files or script files. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-key PrimitiveType: String UpdateType: Immutable .PARAMETER ObjectVersion - + S3Location: https://docs.aws.amazon.com/gamelift/latest/apireference/API_S3Location.html in the *Amazon GameLift API Reference* + The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-object-verison PrimitiveType: String UpdateType: Immutable .PARAMETER RoleArn - Amazon Resource Name ARN: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html for an IAM role that allows Amazon GameLift to access the S3 bucket. + The Amazon Resource Name ARN: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html for an IAM role that allows Amazon GameLift to access the S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetCertificateConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetCertificateConfiguration.ps1 index 09d830173..c5ccd5600 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetCertificateConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetCertificateConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSGameLiftFleetCertificateConfiguration { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet.CertificateConfiguration resource property to the template. + Adds an AWS::GameLift::Fleet.CertificateConfiguration resource property to the template. Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate. .DESCRIPTION Adds an AWS::GameLift::Fleet.CertificateConfiguration resource property to the template. - +Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html .PARAMETER CertificateType + Indicates whether a TLS/SSL certificate is generated for the fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html#cfn-gamelift-fleet-certificateconfiguration-certificatetype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 index 3c6b62e19..aed23bf32 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetIpPermission.ps1 @@ -1,38 +1,38 @@ function Add-VSGameLiftFleetIpPermission { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet.IpPermission resource property to the template. A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers. + Adds an AWS::GameLift::Fleet.IpPermission resource property to the template. A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers. .DESCRIPTION Adds an AWS::GameLift::Fleet.IpPermission resource property to the template. -A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers. +A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html .PARAMETER FromPort - Starting value for a range of allowed port numbers. + A starting value for a range of allowed port numbers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-fromport PrimitiveType: Integer UpdateType: Mutable .PARAMETER IpRange - Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/subnet mask]" or optionally the shortened version "0.0.0.0/subnet mask]". + A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/subnet mask]" or optionally the shortened version "0.0.0.0/subnet mask]". Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-iprange PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol - Network communication protocol used by the fleet. + The network communication protocol used by the fleet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER ToPort - Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-toport PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetResourceCreationLimitPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetResourceCreationLimitPolicy.ps1 index b8882a753..85057e704 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetResourceCreationLimitPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetResourceCreationLimitPolicy.ps1 @@ -1,21 +1,27 @@ function Add-VSGameLiftFleetResourceCreationLimitPolicy { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet.ResourceCreationLimitPolicy resource property to the template. + Adds an AWS::GameLift::Fleet.ResourceCreationLimitPolicy resource property to the template. A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". .DESCRIPTION Adds an AWS::GameLift::Fleet.ResourceCreationLimitPolicy resource property to the template. +A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". +The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId has created fewer than 10 game sessions in the past 60 minutes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html .PARAMETER NewGameSessionsPerCreator + The maximum number of game sessions that an individual can create during the policy period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator PrimitiveType: Integer UpdateType: Mutable .PARAMETER PolicyPeriodInMinutes + The time span used in evaluating the resource creation limit policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-policyperiodinminutes PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetRuntimeConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetRuntimeConfiguration.ps1 index 061f6982a..f9ec3441c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetRuntimeConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetRuntimeConfiguration.ps1 @@ -1,26 +1,36 @@ function Add-VSGameLiftFleetRuntimeConfiguration { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet.RuntimeConfiguration resource property to the template. + Adds an AWS::GameLift::Fleet.RuntimeConfiguration resource property to the template. A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. .DESCRIPTION Adds an AWS::GameLift::Fleet.RuntimeConfiguration resource property to the template. +A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. +The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1 Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2 Run one or more processes of different executables, such as your game server and a metrics tracking program. (3 Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode. + +An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html .PARAMETER GameSessionActivationTimeoutSeconds + The maximum amount of time in seconds that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-gamesessionactivationtimeoutseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaxConcurrentGameSessionActivations + The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-maxconcurrentgamesessionactivations PrimitiveType: Integer UpdateType: Mutable .PARAMETER ServerProcesses + A collection of server process configurations that describe which server processes to run on each instance in a fleet. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-serverprocesses DuplicatesAllowed: False ItemType: ServerProcess diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetServerProcess.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetServerProcess.ps1 index 5332b906b..aa922cba4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetServerProcess.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftFleetServerProcess.ps1 @@ -1,26 +1,34 @@ function Add-VSGameLiftFleetServerProcess { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet.ServerProcess resource property to the template. + Adds an AWS::GameLift::Fleet.ServerProcess resource property to the template. A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration. .DESCRIPTION Adds an AWS::GameLift::Fleet.ServerProcess resource property to the template. - +A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html .PARAMETER ConcurrentExecutions + The number of server processes that use this configuration to run concurrently on an instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions PrimitiveType: Integer UpdateType: Mutable .PARAMETER LaunchPath + The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init function. Game builds and Realtime scripts are installed on instances at the root: ++ Windows for custom game builds only: C:game. Example: "C:gameMyGameserver.exe" ++ Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters + An optional list of parameters to pass to the server executable or Realtime script on launch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-parameters PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueueDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueueDestination.ps1 index 189e3d2c3..58e645717 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueueDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueueDestination.ps1 @@ -1,16 +1,18 @@ function Add-VSGameLiftGameSessionQueueDestination { <# .SYNOPSIS - Adds an AWS::GameLift::GameSessionQueue.Destination resource property to the template. + Adds an AWS::GameLift::GameSessionQueue.Destination resource property to the template. The fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination that is configured for a queue. .DESCRIPTION Adds an AWS::GameLift::GameSessionQueue.Destination resource property to the template. - +The fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination that is configured for a queue. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html .PARAMETER DestinationArn + The Amazon Resource Name ARN that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html#cfn-gamelift-gamesessionqueue-destination-destinationarn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueuePlayerLatencyPolicy.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueuePlayerLatencyPolicy.ps1 index 87a7144de..a1e3827f7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueuePlayerLatencyPolicy.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftGameSessionQueuePlayerLatencyPolicy.ps1 @@ -1,21 +1,25 @@ function Add-VSGameLiftGameSessionQueuePlayerLatencyPolicy { <# .SYNOPSIS - Adds an AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy resource property to the template. + Adds an AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy resource property to the template. The queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information. .DESCRIPTION Adds an AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy resource property to the template. - +The queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html .PARAMETER PolicyDurationSeconds + The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-policydurationseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaximumIndividualPlayerLatencyMilliseconds + The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-maximumindividualplayerlatencymilliseconds PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftMatchmakingConfigurationGameProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftMatchmakingConfigurationGameProperty.ps1 index 18eafbde6..4cd6889e3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftMatchmakingConfigurationGameProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftMatchmakingConfigurationGameProperty.ps1 @@ -1,21 +1,25 @@ function Add-VSGameLiftMatchmakingConfigurationGameProperty { <# .SYNOPSIS - Adds an AWS::GameLift::MatchmakingConfiguration.GameProperty resource property to the template. + Adds an AWS::GameLift::MatchmakingConfiguration.GameProperty resource property to the template. A set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. .DESCRIPTION Adds an AWS::GameLift::MatchmakingConfiguration.GameProperty resource property to the template. - +A set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html .PARAMETER Value + The game property value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-value PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The game property identifier. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-key PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGameLiftScriptS3Location.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGameLiftScriptS3Location.ps1 index 9df6f18f6..33b08e433 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGameLiftScriptS3Location.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGameLiftScriptS3Location.ps1 @@ -1,31 +1,39 @@ function Add-VSGameLiftScriptS3Location { <# .SYNOPSIS - Adds an AWS::GameLift::Script.S3Location resource property to the template. + Adds an AWS::GameLift::Script.S3Location resource property to the template. The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift. .DESCRIPTION Adds an AWS::GameLift::Script.S3Location resource property to the template. - +The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html .PARAMETER ObjectVersion + The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-objectversion PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket + An S3 bucket identifier. This is the name of the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Key + The name of the zip file that contains the build files or script files. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-key PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn + The Amazon Resource Name ARN: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html for an IAM role that allows Amazon GameLift to access the S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-rolearn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerCatalogTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerCatalogTarget.ps1 index deda482bc..53aeb41f6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerCatalogTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerCatalogTarget.ps1 @@ -1,21 +1,25 @@ function Add-VSGlueCrawlerCatalogTarget { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.CatalogTarget resource property to the template. + Adds an AWS::Glue::Crawler.CatalogTarget resource property to the template. Specifies an AWS Glue Data Catalog target. .DESCRIPTION Adds an AWS::Glue::Crawler.CatalogTarget resource property to the template. - +Specifies an AWS Glue Data Catalog target. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html .PARAMETER DatabaseName + The name of the database to be synchronized. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER Tables + A list of the tables to be synchronized. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-tables diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerDynamoDBTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerDynamoDBTarget.ps1 index abd2444a1..cbe36c4b8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerDynamoDBTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerDynamoDBTarget.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueCrawlerDynamoDBTarget { <# .SYNOPSIS - Adds an AWS::Glue::Crawler.DynamoDBTarget resource property to the template. + Adds an AWS::Glue::Crawler.DynamoDBTarget resource property to the template. Specifies an Amazon DynamoDB table to crawl. .DESCRIPTION Adds an AWS::Glue::Crawler.DynamoDBTarget resource property to the template. - +Specifies an Amazon DynamoDB table to crawl. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html .PARAMETER Path + The name of the DynamoDB table to crawl. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-path PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 index 7a4797c30..4ca98fe67 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueCrawlerTargets.ps1 @@ -19,7 +19,7 @@ Specifies data stores to crawl. UpdateType: Mutable .PARAMETER CatalogTargets - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Specifies AWS Glue Data Catalog targets. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-catalogtargets @@ -35,7 +35,7 @@ Specifies data stores to crawl. UpdateType: Mutable .PARAMETER DynamoDBTargets - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Specifies Amazon DynamoDB targets. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-dynamodbtargets diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 index c027ddd21..bae606972 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueDatabaseDatabaseInput.ps1 @@ -26,7 +26,6 @@ The structure used to create or update a database. .PARAMETER Parameters These key-value pairs define parameters and properties of the database. -These key-value pairs define parameters and properties of the database. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-parameters PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueJobNotificationProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueJobNotificationProperty.ps1 index 7a1bc2d79..448f74a2b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueJobNotificationProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueJobNotificationProperty.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueJobNotificationProperty { <# .SYNOPSIS - Adds an AWS::Glue::Job.NotificationProperty resource property to the template. + Adds an AWS::Glue::Job.NotificationProperty resource property to the template. Specifies configuration properties of a notification. .DESCRIPTION Adds an AWS::Glue::Job.NotificationProperty resource property to the template. - +Specifies configuration properties of a notification. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html .PARAMETER NotifyDelayAfter + After a job run starts, the number of minutes to wait before sending a job run delay notification. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html#cfn-glue-job-notificationproperty-notifydelayafter PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 index 95328af7e..b27ee75bb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGluePartitionPartitionInput.ps1 @@ -26,6 +26,7 @@ The structure used to create and update a partition. .PARAMETER Values The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input. +The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 index 51765f7cc..6c4755f5b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueSecurityConfigurationS3Encryptions.ps1 @@ -1,17 +1,11 @@ function Add-VSGlueSecurityConfigurationS3Encryptions { <# .SYNOPSIS - Adds an AWS::Glue::SecurityConfiguration.S3Encryptions resource property to the template. Specifies a list of S3Encryption, containing encyption configuration for Amazon Simple Storage Service (Amazon S3 data for a security configuration. + Adds an AWS::Glue::SecurityConfiguration.S3Encryptions resource property to the template. The S3Encryptions property type specifies the encyption configuration for Amazon Simple Storage Service (Amazon S3 data for a security configuration. .DESCRIPTION Adds an AWS::Glue::SecurityConfiguration.S3Encryptions resource property to the template. -Specifies a list of S3Encryption, containing encyption configuration for Amazon Simple Storage Service (Amazon S3 data for a security configuration. - -*Required*: No - -*Type:* List of S3Encryption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html - -*Update requires:* No interruption +The S3Encryptions property type specifies the encyption configuration for Amazon Simple Storage Service (Amazon S3 data for a security configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryptions.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 index 3ed1e21c3..8cce0a619 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerAction.ps1 @@ -11,21 +11,21 @@ Defines an action to be initiated by a trigger. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html .PARAMETER NotificationProperty - + Action Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Action in the *AWS Glue Developer Guide* + Specifies configuration properties of a job run notification. Type: NotificationProperty Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-notificationproperty UpdateType: Mutable .PARAMETER CrawlerName - + Action Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Action in the *AWS Glue Developer Guide* + The name of the crawler to be used with this action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-crawlername PrimitiveType: String UpdateType: Mutable .PARAMETER Timeout - + Action Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Action in the *AWS Glue Developer Guide* + The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes 48 hours. This overrides the timeout value set in the parent job. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-timeout PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 index b78fc6ca8..70e30666d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerCondition.ps1 @@ -11,7 +11,7 @@ Defines a condition under which a trigger fires. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html .PARAMETER CrawlerName - + Condition Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Condition in the *AWS Glue Developer Guide* + The name of the crawler to which this condition applies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlername PrimitiveType: String @@ -25,7 +25,7 @@ Defines a condition under which a trigger fires. UpdateType: Mutable .PARAMETER CrawlState - + Condition Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Condition in the *AWS Glue Developer Guide* + The state of the crawler to which this condition applies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlstate PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerNotificationProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerNotificationProperty.ps1 index 0845a8a94..c25ea3e1d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerNotificationProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGlueTriggerNotificationProperty.ps1 @@ -1,16 +1,18 @@ function Add-VSGlueTriggerNotificationProperty { <# .SYNOPSIS - Adds an AWS::Glue::Trigger.NotificationProperty resource property to the template. + Adds an AWS::Glue::Trigger.NotificationProperty resource property to the template. Specifies configuration properties of a job run notification. .DESCRIPTION Adds an AWS::Glue::Trigger.NotificationProperty resource property to the template. - +Specifies configuration properties of a job run notification. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-notificationproperty.html .PARAMETER NotifyDelayAfter + After a job run starts, the number of minutes to wait before sending a job run delay notification + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-notificationproperty.html#cfn-glue-trigger-notificationproperty-notifydelayafter PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDownloadOwnerSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDownloadOwnerSetting.ps1 new file mode 100644 index 000000000..db87cbf6a --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionResourceDownloadOwnerSetting.ps1 @@ -0,0 +1,70 @@ +function Add-VSGreengrassResourceDefinitionResourceDownloadOwnerSetting { + <# + .SYNOPSIS + Adds an AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting resource property to the template. + + .DESCRIPTION + Adds an AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html + + .PARAMETER GroupOwner + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinition-resourcedownloadownersetting-groupowner + PrimitiveType: String + UpdateType: Immutable + + .PARAMETER GroupPermission + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinition-resourcedownloadownersetting-grouppermission + PrimitiveType: String + UpdateType: Immutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.Greengrass.ResourceDefinition.ResourceDownloadOwnerSetting')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $GroupOwner, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $GroupPermission + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.Greengrass.ResourceDefinition.ResourceDownloadOwnerSetting' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 index 0b210b0c1..24ea851d5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData.ps1 @@ -12,6 +12,13 @@ function Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData { .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html + .PARAMETER OwnerSetting + + AWS IoT Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/ + + Type: ResourceDownloadOwnerSetting + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-ownersetting + UpdateType: Immutable + .PARAMETER DestinationPath The absolute local path of the resource inside the Lambda environment. @@ -33,6 +40,8 @@ function Add-VSGreengrassResourceDefinitionS3MachineLearningModelResourceData { [cmdletbinding()] Param ( + [parameter(Mandatory = $false)] + $OwnerSetting, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 index dbf314922..5c54bc0fb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResourceData.ps1 @@ -12,6 +12,13 @@ function Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResource .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html + .PARAMETER OwnerSetting + + AWS IoT Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/ + + Type: ResourceDownloadOwnerSetting + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-ownersetting + UpdateType: Immutable + .PARAMETER DestinationPath The absolute local path of the resource inside the Lambda environment. @@ -20,7 +27,7 @@ function Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResource UpdateType: Immutable .PARAMETER SageMakerJobArn - The Amazon Resource Name ARN of the Secrets Manager training job that represents the source model. + The Amazon Resource Name ARN of the Amazon SageMaker training job that represents the source model. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-sagemakerjobarn PrimitiveType: String @@ -33,6 +40,8 @@ function Add-VSGreengrassResourceDefinitionSageMakerMachineLearningModelResource [cmdletbinding()] Param ( + [parameter(Mandatory = $false)] + $OwnerSetting, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDownloadOwnerSetting.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDownloadOwnerSetting.ps1 new file mode 100644 index 000000000..ec79f639a --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionResourceDownloadOwnerSetting.ps1 @@ -0,0 +1,70 @@ +function Add-VSGreengrassResourceDefinitionVersionResourceDownloadOwnerSetting { + <# + .SYNOPSIS + Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting resource property to the template. + + .DESCRIPTION + Adds an AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html + + .PARAMETER GroupOwner + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-groupowner + PrimitiveType: String + UpdateType: Immutable + + .PARAMETER GroupPermission + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-grouppermission + PrimitiveType: String + UpdateType: Immutable + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.Greengrass.ResourceDefinitionVersion.ResourceDownloadOwnerSetting')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $GroupOwner, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $GroupPermission + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.Greengrass.ResourceDefinitionVersion.ResourceDownloadOwnerSetting' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 index 4b0f8783a..a87bf2257 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResourceData.ps1 @@ -12,6 +12,13 @@ function Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResource .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html + .PARAMETER OwnerSetting + + AWS IoT Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/ + + Type: ResourceDownloadOwnerSetting + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-ownersetting + UpdateType: Immutable + .PARAMETER DestinationPath The absolute local path of the resource inside the Lambda environment. @@ -33,6 +40,8 @@ function Add-VSGreengrassResourceDefinitionVersionS3MachineLearningModelResource [cmdletbinding()] Param ( + [parameter(Mandatory = $false)] + $OwnerSetting, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 index 2611ace27..f6170391f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelResourceData.ps1 @@ -12,6 +12,13 @@ function Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelR .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html + .PARAMETER OwnerSetting + + AWS IoT Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/ + + Type: ResourceDownloadOwnerSetting + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-ownersetting + UpdateType: Immutable + .PARAMETER DestinationPath The absolute local path of the resource inside the Lambda environment. @@ -20,7 +27,7 @@ function Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelR UpdateType: Immutable .PARAMETER SageMakerJobArn - The Amazon Resource Name ARN of the Secrets Manager training job that represents the source model. + The Amazon Resource Name ARN of the Amazon SageMaker training job that represents the source model. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-sagemakerjobarn PrimitiveType: String @@ -33,6 +40,8 @@ function Add-VSGreengrassResourceDefinitionVersionSageMakerMachineLearningModelR [cmdletbinding()] Param ( + [parameter(Mandatory = $false)] + $OwnerSetting, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 index 7f39398f8..201ae3a5c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionSubscription.ps1 @@ -13,7 +13,7 @@ function Add-VSGreengrassSubscriptionDefinitionSubscription { http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html .PARAMETER Target - The destination of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + The destination of the message. The value can be a thing ARN, the ARN of a Lambda function alias recommended or version, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-target PrimitiveType: String @@ -27,7 +27,7 @@ function Add-VSGreengrassSubscriptionDefinitionSubscription { UpdateType: Immutable .PARAMETER Source - The originator of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + The originator of the message. The value can be a thing ARN, the ARN of a Lambda function alias recommended or version, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-source PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 index c663f5b22..ce9bd430c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSGreengrassSubscriptionDefinitionVersionSubscription.ps1 @@ -13,7 +13,7 @@ function Add-VSGreengrassSubscriptionDefinitionVersionSubscription { http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html .PARAMETER Target - The destination of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + The destination of the message. The value can be a thing ARN, the ARN of a Lambda function alias recommended or version, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-target PrimitiveType: String @@ -27,7 +27,7 @@ function Add-VSGreengrassSubscriptionDefinitionVersionSubscription { UpdateType: Immutable .PARAMETER Source - The originator of the message. The value can be a thing ARN, a Lambda function ARN, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. + The originator of the message. The value can be a thing ARN, the ARN of a Lambda function alias recommended or version, a connector ARN, cloud which represents the AWS IoT cloud, or GGShadowService. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-source PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupDataflowEndpoint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupDataflowEndpoint.ps1 new file mode 100644 index 000000000..dfe11cc65 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupDataflowEndpoint.ps1 @@ -0,0 +1,61 @@ +function Add-VSGroundStationDataflowEndpointGroupDataflowEndpoint { + <# + .SYNOPSIS + Adds an AWS::GroundStation::DataflowEndpointGroup.DataflowEndpoint resource property to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::DataflowEndpointGroup.DataflowEndpoint resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html + + .PARAMETER Name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-name + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER Address + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-address + UpdateType: Mutable + Type: SocketAddress + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.DataflowEndpointGroup.DataflowEndpoint')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Name, + [parameter(Mandatory = $false)] + $Address + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.DataflowEndpointGroup.DataflowEndpoint' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupEndpointDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupEndpointDetails.ps1 new file mode 100644 index 000000000..a7a4ccba4 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupEndpointDetails.ps1 @@ -0,0 +1,52 @@ +function Add-VSGroundStationDataflowEndpointGroupEndpointDetails { + <# + .SYNOPSIS + Adds an AWS::GroundStation::DataflowEndpointGroup.EndpointDetails resource property to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::DataflowEndpointGroup.EndpointDetails resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html + + .PARAMETER SecurityDetails + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-securitydetails + UpdateType: Mutable + Type: SecurityDetails + + .PARAMETER Endpoint + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-endpoint + UpdateType: Mutable + Type: DataflowEndpoint + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.DataflowEndpointGroup.EndpointDetails')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + $SecurityDetails, + [parameter(Mandatory = $false)] + $Endpoint + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.DataflowEndpointGroup.EndpointDetails' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSecurityDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSecurityDetails.ps1 new file mode 100644 index 000000000..b2e25e9fb --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSecurityDetails.ps1 @@ -0,0 +1,70 @@ +function Add-VSGroundStationDataflowEndpointGroupSecurityDetails { + <# + .SYNOPSIS + Adds an AWS::GroundStation::DataflowEndpointGroup.SecurityDetails resource property to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::DataflowEndpointGroup.SecurityDetails resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html + + .PARAMETER SubnetIds + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-subnetids + UpdateType: Mutable + Type: List + PrimitiveItemType: String + + .PARAMETER SecurityGroupIds + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-securitygroupids + UpdateType: Mutable + Type: List + PrimitiveItemType: String + + .PARAMETER RoleArn + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-rolearn + UpdateType: Mutable + PrimitiveType: String + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.DataflowEndpointGroup.SecurityDetails')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + $SubnetIds, + [parameter(Mandatory = $false)] + $SecurityGroupIds, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $RoleArn + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.DataflowEndpointGroup.SecurityDetails' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSocketAddress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSocketAddress.ps1 new file mode 100644 index 000000000..21586fc85 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGroundStationDataflowEndpointGroupSocketAddress.ps1 @@ -0,0 +1,70 @@ +function Add-VSGroundStationDataflowEndpointGroupSocketAddress { + <# + .SYNOPSIS + Adds an AWS::GroundStation::DataflowEndpointGroup.SocketAddress resource property to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::DataflowEndpointGroup.SocketAddress resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html + + .PARAMETER Name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html#cfn-groundstation-dataflowendpointgroup-socketaddress-name + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER Port + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html#cfn-groundstation-dataflowendpointgroup-socketaddress-port + UpdateType: Mutable + PrimitiveType: Integer + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.DataflowEndpointGroup.SocketAddress')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Name, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Int32","Vaporshell.Function" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Port + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.DataflowEndpointGroup.SocketAddress' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSGroundStationMissionProfileDataflowEdge.ps1 b/VaporShell/Public/Resource Property Types/Add-VSGroundStationMissionProfileDataflowEdge.ps1 new file mode 100644 index 000000000..f0ca6f795 --- /dev/null +++ b/VaporShell/Public/Resource Property Types/Add-VSGroundStationMissionProfileDataflowEdge.ps1 @@ -0,0 +1,70 @@ +function Add-VSGroundStationMissionProfileDataflowEdge { + <# + .SYNOPSIS + Adds an AWS::GroundStation::MissionProfile.DataflowEdge resource property to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::MissionProfile.DataflowEdge resource property to the template. + + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html + + .PARAMETER Source + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html#cfn-groundstation-missionprofile-dataflowedge-source + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER Destination + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html#cfn-groundstation-missionprofile-dataflowedge-destination + UpdateType: Mutable + PrimitiveType: String + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.MissionProfile.DataflowEdge')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Source, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Destination + ) + Begin { + $obj = [PSCustomObject]@{} + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + Default { + $obj | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters.$key + } + } + } + } + End { + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.MissionProfile.DataflowEdge' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$($obj | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 index a1fdcdcd9..dcb869dfb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsChannelRetentionPeriod.ps1 @@ -11,7 +11,7 @@ How long, in days, message data is kept. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html .PARAMETER NumberOfDays - The number of days that message data is kept. The "unlimited" parameter must be false. + The number of days that message data is kept. The unlimited parameter must be false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-numberofdays PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 index a8ea0ef8d..382d1c827 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule.ps1 @@ -1,24 +1,24 @@ function Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRule { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule resource property to the template. When data set contents are created they are delivered to destination specified here. + Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule resource property to the template. When dataset contents are created, they are delivered to destination specified here. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule resource property to the template. -When data set contents are created they are delivered to destination specified here. +When dataset contents are created, they are delivered to destination specified here. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html .PARAMETER Destination - The destination to which data set contents are delivered. + The destination to which dataset contents are delivered. Type: DatasetContentDeliveryRuleDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-destination UpdateType: Mutable .PARAMETER EntryName - The name of the data set content delivery rules entry. + The name of the dataset content delivery rules entry. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-entryname PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 index 873ff535f..0580fa20b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination.ps1 @@ -1,24 +1,24 @@ function Add-VSIoTAnalyticsDatasetDatasetContentDeliveryRuleDestination { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination resource property to the template. The destination to which data set contents are delivered. + Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination resource property to the template. The destination to which dataset contents are delivered. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination resource property to the template. -The destination to which data set contents are delivered. +The destination to which dataset contents are delivered. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html .PARAMETER IotEventsDestinationConfiguration - Configuration information for delivery of data set contents to AWS IoT Events. + Configuration information for delivery of dataset contents to AWS IoT Events. Type: IotEventsDestinationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-ioteventsdestinationconfiguration UpdateType: Mutable .PARAMETER S3DestinationConfiguration - Configuration information for delivery of data set contents to Amazon S3. + Configuration information for delivery of dataset contents to Amazon S3. Type: S3DestinationConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-s3destinationconfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 index ff18ce853..95bc5ebee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDatasetContentVersionValue.ps1 @@ -1,17 +1,17 @@ function Add-VSIoTAnalyticsDatasetDatasetContentVersionValue { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.DatasetContentVersionValue resource property to the template. The data set whose latest contents are used as input to the notebook or application. + Adds an AWS::IoTAnalytics::Dataset.DatasetContentVersionValue resource property to the template. The dataset whose latest contents are used as input to the notebook or application. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.DatasetContentVersionValue resource property to the template. -The data set whose latest contents are used as input to the notebook or application. +The dataset whose latest contents are used as input to the notebook or application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html .PARAMETER DatasetName - The name of the data set whose latest contents are used as input to the notebook or application. + The name of the dataset whose latest contents are used as input to the notebook or application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue-datasetname PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 index afa7cce11..e5c39a315 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetDeltaTime.ps1 @@ -11,14 +11,14 @@ Used to limit data to that which has arrived since the last execution of the act http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html .PARAMETER TimeExpression - An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated. + An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression PrimitiveType: String UpdateType: Mutable .PARAMETER OffsetSeconds - The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the "in flight" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame. + The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 index 5cd4533ec..72689b305 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetGlueConfiguration.ps1 @@ -1,24 +1,24 @@ function Add-VSIoTAnalyticsDatasetGlueConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.GlueConfiguration resource property to the template. Configuration information for coordination with the AWS Glue ETL (extract, transform and load service. + Adds an AWS::IoTAnalytics::Dataset.GlueConfiguration resource property to the template. Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL service. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.GlueConfiguration resource property to the template. -Configuration information for coordination with the AWS Glue ETL (extract, transform and load service. +Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html .PARAMETER TableName - The name of the table in your AWS Glue Data Catalog which is used to perform the ETL extract, transform and load operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets. + The name of the table in your AWS Glue Data Catalog that is used to perform the ETL operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-tablename PrimitiveType: String UpdateType: Mutable .PARAMETER DatabaseName - The name of the database in your AWS Glue Data Catalog in which the table is located. An AWS Glue Data Catalog database contains Glue Data tables. + The name of the database in your AWS Glue Data Catalog in which the table is located. An AWS Glue Data Catalog database contains metadata tables. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-databasename PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 index d7e9f580f..1fc401c75 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration.ps1 @@ -1,24 +1,24 @@ function Add-VSIoTAnalyticsDatasetIotEventsDestinationConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration resource property to the template. Configuration information for delivery of data set contents to AWS IoT Events. + Adds an AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration resource property to the template. Configuration information for delivery of dataset contents to AWS IoT Events. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration resource property to the template. -Configuration information for delivery of data set contents to AWS IoT Events. +Configuration information for delivery of dataset contents to AWS IoT Events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html .PARAMETER InputName - The name of the AWS IoT Events input to which data set contents are delivered. + The name of the AWS IoT Events input to which dataset contents are delivered. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-inputname PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn - The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input. + The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 index f24fd9097..00989f9ee 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetOutputFileUriValue.ps1 @@ -11,7 +11,7 @@ The value of the variable as a structure that specifies an output file URI. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html .PARAMETER FileName - The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket. + The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html#cfn-iotanalytics-dataset-variable-outputfileurivalue-filename PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 index 959c83c2b..e2c6949d3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetResourceConfiguration.ps1 @@ -1,24 +1,24 @@ function Add-VSIoTAnalyticsDatasetResourceConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.ResourceConfiguration resource property to the template. The configuration of the resource used to execute the "containerAction". + Adds an AWS::IoTAnalytics::Dataset.ResourceConfiguration resource property to the template. The configuration of the resource used to execute the containerAction. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.ResourceConfiguration resource property to the template. -The configuration of the resource used to execute the "containerAction". +The configuration of the resource used to execute the containerAction. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html .PARAMETER VolumeSizeInGB - The size in GB of the persistent storage available to the resource instance used to execute the "containerAction" min: 1, max: 50. + The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction min: 1, max: 50. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb PrimitiveType: Integer UpdateType: Mutable .PARAMETER ComputeType - The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 vCPU=4, memory=16GiB or ACU_2 vCPU=8, memory=32GiB. + The type of the compute resource used to execute the containerAction. Possible values are: ACU_1 vCPU=4, memory=16 GiB or ACU_2 vCPU=8, memory=32 GiB. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 index 6772c8d8a..499f9fb33 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetRetentionPeriod.ps1 @@ -11,7 +11,7 @@ How long, in days, message data is kept. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html .PARAMETER NumberOfDays - The number of days that message data is kept. The "unlimited" parameter must be false. + The number of days that message data is kept. The unlimited parameter must be false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-numberofdays PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 index 1c2b507a4..d0a3591e6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetS3DestinationConfiguration.ps1 @@ -1,38 +1,38 @@ function Add-VSIoTAnalyticsDatasetS3DestinationConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.S3DestinationConfiguration resource property to the template. Configuration information for delivery of data set contents to Amazon S3. + Adds an AWS::IoTAnalytics::Dataset.S3DestinationConfiguration resource property to the template. Configuration information for delivery of dataset contents to Amazon S3. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.S3DestinationConfiguration resource property to the template. -Configuration information for delivery of data set contents to Amazon S3. +Configuration information for delivery of dataset contents to Amazon S3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html .PARAMETER GlueConfiguration - Configuration information for coordination with the AWS Glue ETL extract, transform and load service. + Configuration information for coordination with AWS Glue, a fully managed extract, transform and load ETL service. Type: GlueConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration UpdateType: Mutable .PARAMETER Bucket - The name of the Amazon S3 bucket to which data set contents are delivered. + The name of the S3 bucket to which dataset contents are delivered. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER Key - The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket each object in a bucket has exactly one key. To produce a unique key, you can use "!{iotanalytics:scheduledTime}" to insert the time of the scheduled SQL query run, or "!{iotanalytics:versioned} to insert a unique hash identifying the data set, for example: "/DataSet/!{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv". + The key of the dataset contents object. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. To produce a unique key, you can use !{iotanalytics:scheduleTime} to insert the time of the scheduled SQL query run, or !{iotanalytics:versionId} to insert a unique hash identifying the dataset for example, /DataSet/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn - The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources. + The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 index 12a0ba189..f164b05cf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetTriggeringDataset.ps1 @@ -1,11 +1,11 @@ function Add-VSIoTAnalyticsDatasetTriggeringDataset { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.TriggeringDataset resource property to the template. Information about the data set whose content generation triggers the new data set content generation. + Adds an AWS::IoTAnalytics::Dataset.TriggeringDataset resource property to the template. Information about the dataset whose content generation triggers the new dataset content generation. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.TriggeringDataset resource property to the template. -Information about the data set whose content generation triggers the new data set content generation. +Information about the dataset whose content generation triggers the new dataset content generation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 index 481c50c16..bee459d8c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVariable.ps1 @@ -1,17 +1,17 @@ function Add-VSIoTAnalyticsDatasetVariable { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.Variable resource property to the template. An instance of a variable to be passed to the "containerAction" execution. Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue". + Adds an AWS::IoTAnalytics::Dataset.Variable resource property to the template. An instance of a variable to be passed to the containerAction execution. Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.Variable resource property to the template. -An instance of a variable to be passed to the "containerAction" execution. Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue". +An instance of a variable to be passed to the containerAction execution. Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html .PARAMETER DatasetContentVersionValue - The value of the variable as a structure that specifies a data set content version. + The value of the variable as a structure that specifies a dataset content version. Type: DatasetContentVersionValue Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 index eb1dc8013..75383ddf6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatasetVersioningConfiguration.ps1 @@ -1,24 +1,24 @@ function Add-VSIoTAnalyticsDatasetVersioningConfiguration { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Dataset.VersioningConfiguration resource property to the template. Information about the versioning of data set contents. + Adds an AWS::IoTAnalytics::Dataset.VersioningConfiguration resource property to the template. Information about the versioning of dataset contents. .DESCRIPTION Adds an AWS::IoTAnalytics::Dataset.VersioningConfiguration resource property to the template. -Information about the versioning of data set contents. +Information about the versioning of dataset contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html .PARAMETER MaxVersions - How many versions of data set contents will be kept. The "unlimited" parameter must be false. + How many versions of dataset contents are kept. The unlimited parameter must be false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-maxversions PrimitiveType: Integer UpdateType: Mutable .PARAMETER Unlimited - If true, unlimited versions of data set contents will be kept. + If true, unlimited versions of dataset contents are kept. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-unlimited PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 index 6bc60e71f..2ad5e081b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsDatastoreRetentionPeriod.ps1 @@ -11,7 +11,7 @@ How long, in days, message data is kept. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html .PARAMETER NumberOfDays - The number of days that message data is kept. The "unlimited" parameter must be false. + The number of days that message data is kept. The unlimited parameter must be false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-numberofdays PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 index fe056389f..93e8299c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTAnalyticsPipelineDatastore.ps1 @@ -1,11 +1,11 @@ function Add-VSIoTAnalyticsPipelineDatastore { <# .SYNOPSIS - Adds an AWS::IoTAnalytics::Pipeline.Datastore resource property to the template. The 'datastore' activity that specifies where to store the processed data. + Adds an AWS::IoTAnalytics::Pipeline.Datastore resource property to the template. The datastore activity that specifies where to store the processed data. .DESCRIPTION Adds an AWS::IoTAnalytics::Pipeline.Datastore resource property to the template. -The 'datastore' activity that specifies where to store the processed data. +The datastore activity that specifies where to store the processed data. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html @@ -18,7 +18,7 @@ The 'datastore' activity that specifies where to store the processed data. UpdateType: Mutable .PARAMETER Name - The name of the 'datastore' activity. + The name of the datastore activity. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 index 4a820385b..bbe4aadbc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelAction.ps1 @@ -1,11 +1,11 @@ function Add-VSIoTEventsDetectorModelAction { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Action resource property to the template. An action to be performed when the "condition" is TRUE. + Adds an AWS::IoTEvents::DetectorModel.Action resource property to the template. An action to be performed when the condition is TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Action resource property to the template. -An action to be performed when the "condition" is TRUE. +An action to be performed when the condition is TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 index 682d61d74..293feb0e4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelEvent.ps1 @@ -1,17 +1,17 @@ function Add-VSIoTEventsDetectorModelEvent { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.Event resource property to the template. Specifies the "actions" to be performed when the "condition" evaluates to TRUE. + Adds an AWS::IoTEvents::DetectorModel.Event resource property to the template. Specifies the actions to be performed when the condition evaluates to TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.Event resource property to the template. -Specifies the "actions" to be performed when the "condition" evaluates to TRUE. +Specifies the actions to be performed when the condition evaluates to TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html .PARAMETER Condition - Optional] The Boolean expression that when TRUE causes the "actions" to be performed. If not present, the actions are performed =TRUE; if the expression result is not a Boolean value, the actions are NOT performed =FALSE. + Optional. The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed =TRUE. If the expression result is not a Boolean value, the actions are not performed =FALSE. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-condition PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 index b62e71585..c6094bfcf 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelState.ps1 @@ -11,14 +11,14 @@ Information that defines a state of a detector. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html .PARAMETER OnInput - When an input is received and the "condition" is TRUE, perform the specified "actions". + When an input is received and the condition is TRUE, perform the specified actions. Type: OnInput Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-oninput UpdateType: Mutable .PARAMETER OnExit - When exiting this state, perform these "actions" if the specified "condition" is TRUE. + When exiting this state, perform these actions if the specified condition is TRUE. Type: OnExit Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onexit @@ -32,7 +32,7 @@ Information that defines a state of a detector. UpdateType: Mutable .PARAMETER OnEnter - When entering this state, perform these "actions" if the "condition" is TRUE. + When entering this state, perform these actions if the condition is TRUE. Type: OnEnter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onenter diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 index 17800eb44..3152035af 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsDetectorModelTransitionEvent.ps1 @@ -1,17 +1,17 @@ function Add-VSIoTEventsDetectorModelTransitionEvent { <# .SYNOPSIS - Adds an AWS::IoTEvents::DetectorModel.TransitionEvent resource property to the template. Specifies the actions performed and the next state entered when a "condition" evaluates to TRUE. + Adds an AWS::IoTEvents::DetectorModel.TransitionEvent resource property to the template. Specifies the actions performed and the next state entered when a condition evaluates to TRUE. .DESCRIPTION Adds an AWS::IoTEvents::DetectorModel.TransitionEvent resource property to the template. -Specifies the actions performed and the next state entered when a "condition" evaluates to TRUE. +Specifies the actions performed and the next state entered when a condition evaluates to TRUE. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html .PARAMETER Condition - Required] A Boolean expression that when TRUE causes the actions to be performed and the "nextState" to be entered. + Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-condition PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 index 91b0e684f..9d2d488f0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputAttribute.ps1 @@ -1,17 +1,17 @@ function Add-VSIoTEventsInputAttribute { <# .SYNOPSIS - Adds an AWS::IoTEvents::Input.Attribute resource property to the template. The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values specified here are available for use in the condition expressions used by detectors. + Adds an AWS::IoTEvents::Input.Attribute resource property to the template. The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload. Those attributes (and their paired values specified here are available for use in the condition expressions used by detectors. .DESCRIPTION Adds an AWS::IoTEvents::Input.Attribute resource property to the template. -The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values specified here are available for use in the condition expressions used by detectors. +The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload. Those attributes (and their paired values specified here are available for use in the condition expressions used by detectors. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html .PARAMETER JsonPath - An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system BatchPutMessage. Each such message contains a JSON payload, and the attribute and its paired value specified here are available for use in the "condition" expressions used by detectors. + An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events BatchPutMessage. Each such message contains a JSON payload. The attribute and its paired value specified here are available for use in the condition expressions used by detectors. Syntax: .... Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html#cfn-iotevents-input-attribute-jsonpath diff --git a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 index 4f51a78f1..205e31359 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSIoTEventsInputInputDefinition.ps1 @@ -11,7 +11,7 @@ The definition of the input. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html .PARAMETER Attributes - The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes and their paired values specified here are available for use in the "condition" expressions used by detectors that monitor this input. + The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes and their paired values specified here are available for use in the condition expressions used by detectors that monitor this input. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html#cfn-iotevents-input-inputdefinition-attributes diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 index 197c3a704..7db5de870 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration.ps1 @@ -1,17 +1,21 @@ function Add-VSKinesisAnalyticsV2ApplicationCheckpointConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration resource property to the template. Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. + Adds an AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration resource property to the template. Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.8/. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration resource property to the template. -Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. +Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.8/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html .PARAMETER ConfigurationType - Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. + Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters. +If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: ++ **CheckpointingEnabled:** true ++ **CheckpointInterval:** 60000 ++ **MinPauseBetweenCheckpoints:** 5000 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-configurationtype PrimitiveType: String @@ -19,13 +23,15 @@ Describes an application's checkpointing configuration. Checkpointing is the pro .PARAMETER CheckpointInterval Describes the interval in milliseconds between checkpoint operations. +If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-checkpointinterval PrimitiveType: Integer UpdateType: Mutable .PARAMETER MinPauseBetweenCheckpoints - Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing: https://ci.apache.org/projects/flink/flink-docs-stable/ops/state/large_state_tuning.html#tuning-checkpointing in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. + Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing: https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/large_state_tuning.html#tuning-checkpointing in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.8/. +If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-minpausebetweencheckpoints PrimitiveType: Integer @@ -33,6 +39,7 @@ Describes an application's checkpointing configuration. Checkpointing is the pro .PARAMETER CheckpointingEnabled Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application. +If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-checkpointingenabled PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 index 42d22ef59..219bf4293 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationFlinkApplicationConfiguration.ps1 @@ -11,7 +11,7 @@ Describes configuration parameters for a Java-based Amazon Kinesis Data Analytic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html .PARAMETER CheckpointConfiguration - Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. + Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance: https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.8/. Type: CheckpointConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-checkpointconfiguration diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 index ae63ebe05..7e3072fef 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationMonitoringConfiguration.ps1 @@ -11,7 +11,7 @@ Describes configuration parameters for Amazon CloudWatch logging for a Java-base http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html .PARAMETER ConfigurationType - Describes whether to use the default CloudWatch logging configuration for an application. + Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-configurationtype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 index 6618b1351..b61fe6c1c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration.ps1 @@ -1,17 +1,17 @@ function Add-VSKinesisAnalyticsV2ApplicationParallelismConfiguration { <# .SYNOPSIS - Adds an AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration resource property to the template. Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution: https://ci.apache.org/projects/flink/flink-docs-stable/dev/parallel.html in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. + Adds an AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration resource property to the template. Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution: https://ci.apache.org/projects/flink/flink-docs-release-1.8/dev/parallel.html in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.8/. .DESCRIPTION Adds an AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration resource property to the template. -Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution: https://ci.apache.org/projects/flink/flink-docs-stable/dev/parallel.html in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.6/. +Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution: https://ci.apache.org/projects/flink/flink-docs-release-1.8/dev/parallel.html in the Apache Flink Documentation: https://ci.apache.org/projects/flink/flink-docs-release-1.8/. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html .PARAMETER ConfigurationType - Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. + Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-configurationtype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 index 9400a7ef4..b4253e9f9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSKinesisFirehoseDeliveryStreamParquetSerDe.ps1 @@ -18,7 +18,7 @@ A serializer to use for converting data to the Parquet format before storing it UpdateType: Mutable .PARAMETER Compression - The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed. + The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsColumnWildcard.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsColumnWildcard.ps1 index dca4c0dab..2d3cb6ac9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsColumnWildcard.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsColumnWildcard.ps1 @@ -1,16 +1,18 @@ function Add-VSLakeFormationPermissionsColumnWildcard { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.ColumnWildcard resource property to the template. + Adds an AWS::LakeFormation::Permissions.ColumnWildcard resource property to the template. A wildcard object, consisting of an optional list of excluded column names or indexes. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.ColumnWildcard resource property to the template. - +A wildcard object, consisting of an optional list of excluded column names or indexes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-columnwildcard.html .PARAMETER ExcludedColumnNames + Excludes column names. Any column with this name will be excluded. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-columnwildcard.html#cfn-lakeformation-permissions-columnwildcard-excludedcolumnnames diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLocationResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLocationResource.ps1 index a989a324d..667d1b9cb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLocationResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsDataLocationResource.ps1 @@ -1,16 +1,18 @@ function Add-VSLakeFormationPermissionsDataLocationResource { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.DataLocationResource resource property to the template. + Adds an AWS::LakeFormation::Permissions.DataLocationResource resource property to the template. A structure for a data location object where permissions are granted or revoked. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.DataLocationResource resource property to the template. - +A structure for a data location object where permissions are granted or revoked. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html .PARAMETER S3Resource + Currently not supported by AWS CloudFormation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html#cfn-lakeformation-permissions-datalocationresource-s3resource PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableWithColumnsResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableWithColumnsResource.ps1 index 4d8584c01..158b56ab5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableWithColumnsResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLakeFormationPermissionsTableWithColumnsResource.ps1 @@ -1,32 +1,42 @@ function Add-VSLakeFormationPermissionsTableWithColumnsResource { <# .SYNOPSIS - Adds an AWS::LakeFormation::Permissions.TableWithColumnsResource resource property to the template. + Adds an AWS::LakeFormation::Permissions.TableWithColumnsResource resource property to the template. A structure for a table with columns object. This object is only used when granting a SELECT permission. .DESCRIPTION Adds an AWS::LakeFormation::Permissions.TableWithColumnsResource resource property to the template. +A structure for a table with columns object. This object is only used when granting a SELECT permission. +This object must take a value for at least one of ColumnsNames, ColumnsIndexes, or ColumnsWildcard. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html .PARAMETER ColumnNames + The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-columnnames UpdateType: Mutable .PARAMETER DatabaseName + The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-databasename PrimitiveType: String UpdateType: Mutable .PARAMETER Name + The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-name PrimitiveType: String UpdateType: Mutable .PARAMETER ColumnWildcard + A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required. + Type: ColumnWildcard Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-columnwildcard UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasProvisionedConcurrencyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasProvisionedConcurrencyConfiguration.ps1 index 9be438928..e6deeacc1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasProvisionedConcurrencyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasProvisionedConcurrencyConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaAliasProvisionedConcurrencyConfiguration { <# .SYNOPSIS - Adds an AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration resource property to the template. + Adds an AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration resource property to the template. A provisioned concurrency configuration for a function's alias. .DESCRIPTION Adds an AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration resource property to the template. - +A provisioned concurrency configuration for a function's alias. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html .PARAMETER ProvisionedConcurrentExecutions + The amount of provisioned concurrency to allocate for the alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html#cfn-lambda-alias-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 index 9920b2bec..15cebd28e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaAliasVersionWeight.ps1 @@ -11,14 +11,14 @@ The traffic-shifting: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffi http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html .PARAMETER FunctionVersion - The name of the second alias. + The qualifier of the second version. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion PrimitiveType: String UpdateType: Mutable .PARAMETER FunctionWeight - The percentage of traffic that's routed to the second alias. + The percentage of traffic that the alias routes to the second version. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight PrimitiveType: Double diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigDestinationConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigDestinationConfig.ps1 index 6f6574632..de80bde33 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigDestinationConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigDestinationConfig.ps1 @@ -1,21 +1,25 @@ function Add-VSLambdaEventInvokeConfigDestinationConfig { <# .SYNOPSIS - Adds an AWS::Lambda::EventInvokeConfig.DestinationConfig resource property to the template. + Adds an AWS::Lambda::EventInvokeConfig.DestinationConfig resource property to the template. A configuration object that specifies the destination of an event after Lambda processes it. .DESCRIPTION Adds an AWS::Lambda::EventInvokeConfig.DestinationConfig resource property to the template. - +A configuration object that specifies the destination of an event after Lambda processes it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html .PARAMETER OnSuccess + The destination configuration for successful invocations. + Type: OnSuccess Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess UpdateType: Mutable .PARAMETER OnFailure + The destination configuration for failed invocations. + Type: OnFailure Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnFailure.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnFailure.ps1 index 6356d3542..2db0596c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnFailure.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnFailure.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaEventInvokeConfigOnFailure { <# .SYNOPSIS - Adds an AWS::Lambda::EventInvokeConfig.OnFailure resource property to the template. + Adds an AWS::Lambda::EventInvokeConfig.OnFailure resource property to the template. A destination for events that failed processing. .DESCRIPTION Adds an AWS::Lambda::EventInvokeConfig.OnFailure resource property to the template. - +A destination for events that failed processing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onfailure.html .PARAMETER Destination + The Amazon Resource Name ARN of the destination resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onfailure.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure-destination PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnSuccess.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnSuccess.ps1 index 0e61ef68e..cd198e8e4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnSuccess.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventInvokeConfigOnSuccess.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaEventInvokeConfigOnSuccess { <# .SYNOPSIS - Adds an AWS::Lambda::EventInvokeConfig.OnSuccess resource property to the template. + Adds an AWS::Lambda::EventInvokeConfig.OnSuccess resource property to the template. A destination for events that were processed successfully. .DESCRIPTION Adds an AWS::Lambda::EventInvokeConfig.OnSuccess resource property to the template. - +A destination for events that were processed successfully. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onsuccess.html .PARAMETER Destination + The Amazon Resource Name ARN of the destination resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onsuccess.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess-destination PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingDestinationConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingDestinationConfig.ps1 index cac23bb5b..2d92b5496 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingDestinationConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingDestinationConfig.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaEventSourceMappingDestinationConfig { <# .SYNOPSIS - Adds an AWS::Lambda::EventSourceMapping.DestinationConfig resource property to the template. + Adds an AWS::Lambda::EventSourceMapping.DestinationConfig resource property to the template. (Streams An Amazon SQS queue or Amazon SNS topic destination for discarded records. .DESCRIPTION Adds an AWS::Lambda::EventSourceMapping.DestinationConfig resource property to the template. - +(Streams An Amazon SQS queue or Amazon SNS topic destination for discarded records. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html .PARAMETER OnFailure + The destination configuration for failed invocations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html#cfn-lambda-eventsourcemapping-destinationconfig-onfailure Type: OnFailure UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingOnFailure.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingOnFailure.ps1 index 5bdede03c..27d7e6603 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingOnFailure.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaEventSourceMappingOnFailure.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaEventSourceMappingOnFailure { <# .SYNOPSIS - Adds an AWS::Lambda::EventSourceMapping.OnFailure resource property to the template. + Adds an AWS::Lambda::EventSourceMapping.OnFailure resource property to the template. A destination for events that failed processing. .DESCRIPTION Adds an AWS::Lambda::EventSourceMapping.OnFailure resource property to the template. - +A destination for events that failed processing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html .PARAMETER Destination + The Amazon Resource Name ARN of the destination resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html#cfn-lambda-eventsourcemapping-onfailure-destination PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 index b105890ee..367d94f0d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionCode.ps1 @@ -36,7 +36,7 @@ Changes to a deployment package in Amazon S3 are not detected automatically duri .PARAMETER ZipFile Node.js and Python The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package: https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html. For the Handler property, the first part of the handler identifier must be index. For example, index.handler. Your source code can contain up to 4096 characters. For JSON, you must escape quotes and special characters such as newline n with a backslash. -If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module cfn-module that simplifies sending responses. +If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module cfn-response: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html that simplifies sending responses. See Using AWS Lambda with AWS CloudFormation: https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html for details. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 index 9ac87b4ef..8b7bd80ab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionDeadLetterConfig.ps1 @@ -1,11 +1,11 @@ function Add-VSLambdaFunctionDeadLetterConfig { <# .SYNOPSIS - Adds an AWS::Lambda::Function.DeadLetterConfig resource property to the template. The dead letter queue: https://docs.aws.amazon.com/lambda/latest/dg/dlq.html for failed asynchronous invocations. + Adds an AWS::Lambda::Function.DeadLetterConfig resource property to the template. The dead-letter queue: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq for failed asynchronous invocations. .DESCRIPTION Adds an AWS::Lambda::Function.DeadLetterConfig resource property to the template. -The dead letter queue: https://docs.aws.amazon.com/lambda/latest/dg/dlq.html for failed asynchronous invocations. +The dead-letter queue: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq for failed asynchronous invocations. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 index cbcca16ea..931beb972 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionTracingConfig.ps1 @@ -1,11 +1,11 @@ function Add-VSLambdaFunctionTracingConfig { <# .SYNOPSIS - Adds an AWS::Lambda::Function.TracingConfig resource property to the template. The function's AWS X-Ray tracing configuration. + Adds an AWS::Lambda::Function.TracingConfig resource property to the template. The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active. .DESCRIPTION Adds an AWS::Lambda::Function.TracingConfig resource property to the template. -The function's AWS X-Ray tracing configuration. +The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 index 492459112..45d3b0c6e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaFunctionVpcConfig.ps1 @@ -1,11 +1,17 @@ function Add-VSLambdaFunctionVpcConfig { <# .SYNOPSIS - Adds an AWS::Lambda::Function.VpcConfig resource property to the template. The VPC security groups and subnets that are attached to a Lambda function. + Adds an AWS::Lambda::Function.VpcConfig resource property to the template. The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings: https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html. .DESCRIPTION Adds an AWS::Lambda::Function.VpcConfig resource property to the template. -The VPC security groups and subnets that are attached to a Lambda function. +The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings: https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html. + +**Note** + +When you delete a function, AWS CloudFormation monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before AWS CloudFormation can delete the VPC's resources. + +To monitor network interfaces, AWS CloudFormation needs the ec2:DescribeNetworkInterfaces permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, AWS CloudFormation does not wait for network interfaces to be deleted. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSLambdaVersionProvisionedConcurrencyConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLambdaVersionProvisionedConcurrencyConfiguration.ps1 index b173abe3a..7c407d894 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLambdaVersionProvisionedConcurrencyConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLambdaVersionProvisionedConcurrencyConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSLambdaVersionProvisionedConcurrencyConfiguration { <# .SYNOPSIS - Adds an AWS::Lambda::Version.ProvisionedConcurrencyConfiguration resource property to the template. + Adds an AWS::Lambda::Version.ProvisionedConcurrencyConfiguration resource property to the template. A provisioned concurrency configuration for a function's version. .DESCRIPTION Adds an AWS::Lambda::Version.ProvisionedConcurrencyConfiguration resource property to the template. - +A provisioned concurrency configuration for a function's version. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-version-provisionedconcurrencyconfiguration.html .PARAMETER ProvisionedConcurrentExecutions + The amount of provisioned concurrency to allocate for the version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-version-provisionedconcurrencyconfiguration.html#cfn-lambda-version-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 index 0c5836fdc..93dc3bd35 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSLogsMetricFilterMetricTransformation.ps1 @@ -25,7 +25,7 @@ MetricTransformation is a property of the AWS::Logs::MetricFilter resource that UpdateType: Mutable .PARAMETER MetricNamespace - The namespace of the CloudWatch metric. + A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricnamespace PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 index b23eb722f..663a70bf1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterBrokerNodeGroupInfo.ps1 @@ -11,7 +11,7 @@ The setup to be used for brokers in the cluster. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html .PARAMETER SecurityGroups - The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. + The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission. PrimitiveItemType: String Type: List @@ -19,7 +19,9 @@ The setup to be used for brokers in the cluster. UpdateType: Immutable .PARAMETER ClientSubnets - The list of subnets to connect to in the client virtual private cloud VPC. AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e. + The list of subnets to connect to in the client virtual private cloud VPC. AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. +Specify exactly two subnets if you are using one of the following Regions: South America São Paulo, Canada Central, or US West N. California. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify. +Client subnets can't be in Availability Zone us-east-1e. PrimitiveItemType: String Type: List @@ -34,14 +36,17 @@ The setup to be used for brokers in the cluster. UpdateType: Immutable .PARAMETER BrokerAZDistribution - The distribution of broker nodes across Availability Zones. + The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. +Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets that you provide when you create the cluster. +To create a cluster, specify exactly two subnets if you are using one of the following Regions: South America São Paulo, Canada Central, or US West N. California. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. +Client subnets can't be in Availability Zone us-east-1e. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-brokerazdistribution PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceType - The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. + The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-instancetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterJmxExporter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterJmxExporter.ps1 index fe7718c6f..1bcb61a6f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterJmxExporter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterJmxExporter.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterJmxExporter { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.JmxExporter resource property to the template. + Adds an AWS::MSK::Cluster.JmxExporter resource property to the template. Indicates whether you want to enable or disable the JMX Exporter. .DESCRIPTION Adds an AWS::MSK::Cluster.JmxExporter resource property to the template. - +Indicates whether you want to enable or disable the JMX Exporter. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-jmxexporter.html .PARAMETER EnabledInBroker + Indicates whether you want to enable or disable the JMX Exporter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-jmxexporter.html#cfn-msk-cluster-jmxexporter-enabledinbroker PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterNodeExporter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterNodeExporter.ps1 index 64e0e93ed..c31ce17c2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterNodeExporter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterNodeExporter.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterNodeExporter { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.NodeExporter resource property to the template. + Adds an AWS::MSK::Cluster.NodeExporter resource property to the template. Indicates whether you want to enable or disable the Node Exporter. .DESCRIPTION Adds an AWS::MSK::Cluster.NodeExporter resource property to the template. - +Indicates whether you want to enable or disable the Node Exporter. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-nodeexporter.html .PARAMETER EnabledInBroker + Indicates whether you want to enable or disable the Node Exporter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-nodeexporter.html#cfn-msk-cluster-nodeexporter-enabledinbroker PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterOpenMonitoring.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterOpenMonitoring.ps1 index 995542dc7..9f858f8ab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterOpenMonitoring.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterOpenMonitoring.ps1 @@ -1,16 +1,18 @@ function Add-VSMSKClusterOpenMonitoring { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.OpenMonitoring resource property to the template. + Adds an AWS::MSK::Cluster.OpenMonitoring resource property to the template. JMX and Node monitoring for the MSK cluster. .DESCRIPTION Adds an AWS::MSK::Cluster.OpenMonitoring resource property to the template. - +JMX and Node monitoring for the MSK cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-openmonitoring.html .PARAMETER Prometheus + Prometheus exporter settings. + Type: Prometheus Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-openmonitoring.html#cfn-msk-cluster-openmonitoring-prometheus UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterPrometheus.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterPrometheus.ps1 index 8b5f4e325..227516fe8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMSKClusterPrometheus.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMSKClusterPrometheus.ps1 @@ -1,21 +1,25 @@ function Add-VSMSKClusterPrometheus { <# .SYNOPSIS - Adds an AWS::MSK::Cluster.Prometheus resource property to the template. + Adds an AWS::MSK::Cluster.Prometheus resource property to the template. Prometheus settings for open monitoring. .DESCRIPTION Adds an AWS::MSK::Cluster.Prometheus resource property to the template. - +Prometheus settings for open monitoring. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html .PARAMETER JmxExporter + Indicates whether you want to enable or disable the JMX Exporter. + Type: JmxExporter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html#cfn-msk-cluster-prometheus-jmxexporter UpdateType: Mutable .PARAMETER NodeExporter + Indicates whether you want to enable or disable the Node Exporter. + Type: NodeExporter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html#cfn-msk-cluster-prometheus-nodeexporter UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaConvertJobTemplateAccelerationSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaConvertJobTemplateAccelerationSettings.ps1 index 357716511..4746c8abc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaConvertJobTemplateAccelerationSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaConvertJobTemplateAccelerationSettings.ps1 @@ -1,16 +1,18 @@ function Add-VSMediaConvertJobTemplateAccelerationSettings { <# .SYNOPSIS - Adds an AWS::MediaConvert::JobTemplate.AccelerationSettings resource property to the template. + Adds an AWS::MediaConvert::JobTemplate.AccelerationSettings resource property to the template. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. .DESCRIPTION Adds an AWS::MediaConvert::JobTemplate.AccelerationSettings resource property to the template. - +Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconvert-jobtemplate-accelerationsettings.html .PARAMETER Mode + Specify the conditions when the service will run your job with accelerated transcoding. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconvert-jobtemplate-accelerationsettings.html#cfn-mediaconvert-jobtemplate-accelerationsettings-mode PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMultiplexProgramChannelDestinationSettings.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMultiplexProgramChannelDestinationSettings.ps1 index 938568d8f..168082431 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMultiplexProgramChannelDestinationSettings.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelMultiplexProgramChannelDestinationSettings.ps1 @@ -1,21 +1,25 @@ function Add-VSMediaLiveChannelMultiplexProgramChannelDestinationSettings { <# .SYNOPSIS - Adds an AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings resource property to the template. + Adds an AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings resource property to the template. The MultiplexProgramChannelDestinationSettings property type specifies Not currently supported by AWS CloudFormation. for an AWS::MediaLive::Channel: aws-resource-medialive-channel.md. .DESCRIPTION Adds an AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings resource property to the template. - +The MultiplexProgramChannelDestinationSettings property type specifies Not currently supported by AWS CloudFormation. for an AWS::MediaLive::Channel: aws-resource-medialive-channel.md. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html .PARAMETER MultiplexId + Not currently supported by AWS CloudFormation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html#cfn-medialive-channel-multiplexprogramchanneldestinationsettings-multiplexid PrimitiveType: String UpdateType: Mutable .PARAMETER ProgramName + Not currently supported by AWS CloudFormation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html#cfn-medialive-channel-multiplexprogramchanneldestinationsettings-programname PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 index 7a72f0b83..c19d0dcfa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSMediaLiveChannelOutputDestination.ps1 @@ -13,7 +13,7 @@ This entity is at the top level in the channel. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html .PARAMETER MultiplexSettings - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + Not currently supported by AWS CloudFormation. Type: MultiplexProgramChannelDestinationSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-multiplexsettings diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 index 4f88a1d83..d5fe29e60 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointApplicationSettingsLimits.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointApplicationSettingsLimits { <# .SYNOPSIS - Adds an AWS::Pinpoint::ApplicationSettings.Limits resource property to the template. The default sending limits for campaigns in the application. + Adds an AWS::Pinpoint::ApplicationSettings.Limits resource property to the template. Specifies the default sending limits for campaigns in the application. You can override these limits for a specific campaign. .DESCRIPTION Adds an AWS::Pinpoint::ApplicationSettings.Limits resource property to the template. -The default sending limits for campaigns in the application. +Specifies the default sending limits for campaigns in the application. You can override these limits for a specific campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 index 243d137b0..3cc0b77d8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignAttributeDimension.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointCampaignAttributeDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.AttributeDimension resource property to the template. Specifies the criteria for including or excluding endpoints from a segment. + Adds an AWS::Pinpoint::Campaign.AttributeDimension resource property to the template. Specifies attribute-based criteria for including or excluding endpoints from a segment. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.AttributeDimension resource property to the template. -Specifies the criteria for including or excluding endpoints from a segment. +Specifies attribute-based criteria for including or excluding endpoints from a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 index 2acdf6175..537d60915 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEmailMessage.ps1 @@ -18,7 +18,7 @@ Specifies the content and "From" address for an email message that's sent to rec UpdateType: Mutable .PARAMETER HtmlBody - The body of the email, in HTML format, for recipients whose email clients support HTML content. + The body of the email, in HTML format, for recipients whose email clients render HTML content. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-htmlbody PrimitiveType: String @@ -32,7 +32,7 @@ Specifies the content and "From" address for an email message that's sent to rec UpdateType: Mutable .PARAMETER Body - The body of the email for recipients whose email clients don't support HTML content. + The body of the email for recipients whose email clients don't render HTML content. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-body PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 index eae93d11f..3d47ac955 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignCampaignEventFilter.ps1 @@ -11,7 +11,7 @@ Specifies the settings for events that cause a campaign to be sent. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html .PARAMETER FilterType - The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event Events resource occurs. + The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event occurs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-filtertype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 index b6694b8dc..bfb1920fa 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignEventDimensions.ps1 @@ -11,21 +11,21 @@ Specifies the dimensions for an event filter that determines when a campaign is http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html .PARAMETER Metrics - One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. + One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-metrics PrimitiveType: Json UpdateType: Mutable .PARAMETER EventType - The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app. + The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application. Type: SetDimension Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-eventtype UpdateType: Mutable .PARAMETER Attributes - One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. + One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-attributes PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 index 33241c5fe..763218a43 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignLimits.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointCampaignLimits { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.Limits resource property to the template. Specifies the limits on the messages that a campaign can send. + Adds an AWS::Pinpoint::Campaign.Limits resource property to the template. Specifies limits on the messages that a campaign can send. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.Limits resource property to the template. -Specifies the limits on the messages that a campaign can send. +Specifies limits on the messages that a campaign can send. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 index f52dcd03a..1be850936 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessage.ps1 @@ -85,7 +85,7 @@ This value doesn't apply to messages that are sent through the Amazon Device Mes UpdateType: Mutable .PARAMETER RawContent - The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message. + The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-rawcontent PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 index 80d0c53a8..b288770b4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMessageConfiguration.ps1 @@ -11,7 +11,7 @@ Specifies the message configuration settings for a campaign. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html .PARAMETER APNSMessage - The message that the campaign sends through the APNS Apple Push Notification service channel. This message overrides the default message. + The message that the campaign sends through the APNs Apple Push Notification service channel. This message overrides the default message. Type: Message Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-apnsmessage diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 index a3853c298..8a3155220 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignMetricDimension.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointCampaignMetricDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.MetricDimension resource property to the template. Specifies the dimension settings for custom metrics that your app reports to Amazon Pinpoint. + Adds an AWS::Pinpoint::Campaign.MetricDimension resource property to the template. Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.MetricDimension resource property to the template. -Specifies the dimension settings for custom metrics that your app reports to Amazon Pinpoint. +Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 index 74cf3c203..726202459 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSchedule.ps1 @@ -19,9 +19,9 @@ Specifies the schedule settings for a campaign. .PARAMETER QuietTime The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met: -- The EndpointDemographic.Timezone property of the endpoint is set to a valid value. -- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign. -- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign. ++ The EndpointDemographic.Timezone property of the endpoint is set to a valid value. ++ The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign. ++ The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign. If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled. Type: QuietTime @@ -29,14 +29,14 @@ If any of the preceding conditions isn't met, the endpoint will receive messages UpdateType: Mutable .PARAMETER EndTime - The scheduled time, in ISO 8601 format, for the campaign to end. + The scheduled time, in ISO 8601 format, when the campaign ended or will end. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-endtime PrimitiveType: String UpdateType: Mutable .PARAMETER StartTime - The scheduled time, in ISO 8601 format, for the campaign to begin. + The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-starttime PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 index 77b336214..182d2ab93 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignSetDimension.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointCampaignSetDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign.SetDimension resource property to the template. Specifies the dimension type and values for a segment. + Adds an AWS::Pinpoint::Campaign.SetDimension resource property to the template. Specifies the dimension type and values for a segment dimension. .DESCRIPTION Adds an AWS::Pinpoint::Campaign.SetDimension resource property to the template. -Specifies the dimension type and values for a segment. +Specifies the dimension type and values for a segment dimension. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html @@ -18,7 +18,7 @@ Specifies the dimension type and values for a segment. UpdateType: Mutable .PARAMETER Values - The criteria values for the segment dimension to use. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. + The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 index 230c54504..aba48c075 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointCampaignWriteTreatmentResource.ps1 @@ -11,7 +11,7 @@ Specifies the settings for a campaign treatment. A treatment is a variation of a http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html .PARAMETER TreatmentDescription - The custom description of the treatment. + A custom description of the treatment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAPNSPushNotificationTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAPNSPushNotificationTemplate.ps1 index 1ae0f4f8a..648788382 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAPNSPushNotificationTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAPNSPushNotificationTemplate.ps1 @@ -1,41 +1,56 @@ function Add-VSPinpointPushTemplateAPNSPushNotificationTemplate { <# .SYNOPSIS - Adds an AWS::Pinpoint::PushTemplate.APNSPushNotificationTemplate resource property to the template. + Adds an AWS::Pinpoint::PushTemplate.APNSPushNotificationTemplate resource property to the template. The AWS::Pinpoint::PushTemplate APNSPushNotificationTemplate resource defines channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service channel. .DESCRIPTION Adds an AWS::Pinpoint::PushTemplate.APNSPushNotificationTemplate resource property to the template. - +The AWS::Pinpoint::PushTemplate APNSPushNotificationTemplate resource defines channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html .PARAMETER Action + The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: ++ OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. ++ DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. ++ URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action PrimitiveType: String UpdateType: Mutable .PARAMETER MediaUrl + The URL of an image or video to display in push notifications that are based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-mediaurl PrimitiveType: String UpdateType: Mutable .PARAMETER Title + The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title PrimitiveType: String UpdateType: Mutable .PARAMETER Sound + The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-sound PrimitiveType: String UpdateType: Mutable .PARAMETER Body + The message body to use in push notifications that are based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-body PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAndroidPushNotificationTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAndroidPushNotificationTemplate.ps1 index 688a17066..80283621e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAndroidPushNotificationTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateAndroidPushNotificationTemplate.ps1 @@ -1,51 +1,70 @@ function Add-VSPinpointPushTemplateAndroidPushNotificationTemplate { <# .SYNOPSIS - Adds an AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate resource property to the template. + Adds an AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate resource property to the template. The AWS::Pinpoint::PushTemplate AndroidPushNotificationTemplate resource defines channel-specific content and settings for a message template that can be used in push notifications that are sent through the following channels: ADM (Amazon Device Messaging, Baidu (Baidu Cloud Push, or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging. .DESCRIPTION Adds an AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate resource property to the template. - +The AWS::Pinpoint::PushTemplate AndroidPushNotificationTemplate resource defines channel-specific content and settings for a message template that can be used in push notifications that are sent through the following channels: ADM (Amazon Device Messaging, Baidu (Baidu Cloud Push, or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html .PARAMETER Action + The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: ++ OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. ++ DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. ++ URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-action PrimitiveType: String UpdateType: Mutable .PARAMETER ImageUrl + The URL of an image to display in a push notification that's based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageurl PrimitiveType: String UpdateType: Mutable .PARAMETER SmallImageIconUrl + The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-smallimageiconurl PrimitiveType: String UpdateType: Mutable .PARAMETER Title + The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-title PrimitiveType: String UpdateType: Mutable .PARAMETER ImageIconUrl + The URL of the large icon image to display in the content view of a push notification that's based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageiconurl PrimitiveType: String UpdateType: Mutable .PARAMETER Sound + The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-sound PrimitiveType: String UpdateType: Mutable .PARAMETER Body + The message body to use in a push notification that's based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-body PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateDefaultPushNotificationTemplate.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateDefaultPushNotificationTemplate.ps1 index 7b8153594..1fb87b726 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateDefaultPushNotificationTemplate.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointPushTemplateDefaultPushNotificationTemplate.ps1 @@ -1,36 +1,50 @@ function Add-VSPinpointPushTemplateDefaultPushNotificationTemplate { <# .SYNOPSIS - Adds an AWS::Pinpoint::PushTemplate.DefaultPushNotificationTemplate resource property to the template. + Adds an AWS::Pinpoint::PushTemplate.DefaultPushNotificationTemplate resource property to the template. The AWS::Pinpoint::PushTemplate DefaultPushNotificationTemplate resource defines the default settings and content for a message template that can be used in messages that are sent through a push notification channel. .DESCRIPTION Adds an AWS::Pinpoint::PushTemplate.DefaultPushNotificationTemplate resource property to the template. - +The AWS::Pinpoint::PushTemplate DefaultPushNotificationTemplate resource defines the default settings and content for a message template that can be used in messages that are sent through a push notification channel. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html .PARAMETER Action + The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: ++ OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. ++ DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. ++ URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-action PrimitiveType: String UpdateType: Mutable .PARAMETER Title + The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-title PrimitiveType: String UpdateType: Mutable .PARAMETER Sound + The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. +For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-sound PrimitiveType: String UpdateType: Mutable .PARAMETER Body + The message body to use in push notifications that are based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-body PrimitiveType: String UpdateType: Mutable .PARAMETER Url + The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-url PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 index 242a2a49a..a1d14eda9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentAttributeDimension.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointSegmentAttributeDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.AttributeDimension resource property to the template. Specifies the criteria for including or excluding endpoints from a segment. + Adds an AWS::Pinpoint::Segment.AttributeDimension resource property to the template. Specifies attribute-based criteria for including or excluding endpoints from a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.AttributeDimension resource property to the template. -Specifies the criteria for including or excluding endpoints from a segment. +Specifies attribute-based criteria for including or excluding endpoints from a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 index 49c65938c..389ea5b66 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentBehavior.ps1 @@ -1,17 +1,17 @@ function Add-VSPinpointSegmentBehavior { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Behavior resource property to the template. The behavior-based criteria for the segment, such as how recently users have used your app. + Adds an AWS::Pinpoint::Segment.Behavior resource property to the template. Specifies behavior-based criteria, such as how recently users have used your app, for a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Behavior resource property to the template. -The behavior-based criteria for the segment, such as how recently users have used your app. +Specifies behavior-based criteria, such as how recently users have used your app, for a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior.html .PARAMETER Recency - Specifies how recently segment members were active. + The dimension settings that are based on how recently an endpoint was active. Type: Recency Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior.html#cfn-pinpoint-segment-segmentdimensions-behavior-recency diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 index 4283de2e2..b5a7972c4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentCoordinates.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointSegmentCoordinates { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Coordinates resource property to the template. The latitude and longitude of the location. + Adds an AWS::Pinpoint::Segment.Coordinates resource property to the template. Specifies the GPS coordinates of a location. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Coordinates resource property to the template. -The latitude and longitude of the location. +Specifies the GPS coordinates of a location. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint-coordinates.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 index bd83130d1..d5a8cb0e8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentDemographic.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointSegmentDemographic { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Demographic resource property to the template. The demographic-based criteria, such as device platform, for the segment. + Adds an AWS::Pinpoint::Segment.Demographic resource property to the template. Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Demographic resource property to the template. -The demographic-based criteria, such as device platform, for the segment. +Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-demographic.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 index 0625130f5..6b00b62c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGPSPoint.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointSegmentGPSPoint { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.GPSPoint resource property to the template. The GPS coordinates of the endpoint location. + Adds an AWS::Pinpoint::Segment.GPSPoint resource property to the template. Specifies GPS-based criteria for including or excluding endpoints from a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.GPSPoint resource property to the template. -The GPS coordinates of the endpoint location. +Specifies GPS-based criteria for including or excluding endpoints from a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location-gpspoint.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 index 67b4462a0..ed9f7a9b3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentGroups.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointSegmentGroups { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Groups resource property to the template. An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. + Adds an AWS::Pinpoint::Segment.Groups resource property to the template. Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Groups resource property to the template. -An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. +Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html @@ -25,7 +25,7 @@ An array that defines the set of segment criteria to evaluate when handling segm UpdateType: Mutable .PARAMETER Dimensions - An array that defines the dimensions to include or exclude from the segment. + An array that defines the dimensions for the segment. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html#cfn-pinpoint-segment-segmentgroups-groups-dimensions @@ -33,8 +33,7 @@ An array that defines the set of segment criteria to evaluate when handling segm UpdateType: Mutable .PARAMETER SourceSegments - The base segment to build the segment on. A base segment, also called a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. -You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it. + The base segment to build the segment on. A base segment, also referred to as a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. You can specify more than one dimensional segment or only one imported segment. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups.html#cfn-pinpoint-segment-segmentgroups-groups-sourcesegments diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 index 660117e61..3ca4ee281 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentLocation.ps1 @@ -1,17 +1,17 @@ function Add-VSPinpointSegmentLocation { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Location resource property to the template. The location-based criteria, such as region or GPS coordinates, for the segment. + Adds an AWS::Pinpoint::Segment.Location resource property to the template. Specifies location-based criteria, such as country or region, for a segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Location resource property to the template. -The location-based criteria, such as region or GPS coordinates, for the segment. +Specifies location-based criteria, such as country or region, for a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location.html .PARAMETER GPSPoint - The GPS point dimension for the segment. + The GPS location and range for the segment. Type: GPSPoint Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-location.html#cfn-pinpoint-segment-segmentdimensions-location-gpspoint diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 index e117839c9..c366713f8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentRecency.ps1 @@ -1,25 +1,24 @@ function Add-VSPinpointSegmentRecency { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.Recency resource property to the template. Specifies how recently segment members were active. + Adds an AWS::Pinpoint::Segment.Recency resource property to the template. Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active. .DESCRIPTION Adds an AWS::Pinpoint::Segment.Recency resource property to the template. -Specifies how recently segment members were active. +Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior-recency.html .PARAMETER Duration - The duration to use when determining which users have been active or inactive with your app. -Possible values: HR_24 | DAY_7 | DAY_14 | DAY_30. + The duration to use when determining whether an endpoint is active or inactive. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior-recency.html#cfn-pinpoint-segment-segmentdimensions-behavior-recency-duration PrimitiveType: String UpdateType: Mutable .PARAMETER RecencyType - The type of recency dimension to use for the segment. Valid values are: ACTIVE and INACTIVE. If the value is ACTIVE, the segment includes users who have used your app within the specified duration are included in the segment. If the value is INACTIVE, the segment includes users who haven't used your app within the specified duration are included in the segment. + The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions-behavior-recency.html#cfn-pinpoint-segment-segmentdimensions-behavior-recency-recencytype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 index 457b168df..ef0f8ec05 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSegmentGroups.ps1 @@ -1,17 +1,17 @@ function Add-VSPinpointSegmentSegmentGroups { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SegmentGroups resource property to the template. Specifies the set of segment criteria to evaluate when handling segment groups for the segment. + Adds an AWS::Pinpoint::Segment.SegmentGroups resource property to the template. Specifies one or more segment groups that apply to a segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SegmentGroups resource property to the template. -Specifies the set of segment criteria to evaluate when handling segment groups for the segment. +Specifies one or more segment groups that apply to a segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html .PARAMETER Groups - Specifies the set of segment criteria to evaluate when handling segment groups for the segment. + An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-groups diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 index f190e1d42..6b92d8223 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSetDimension.ps1 @@ -1,11 +1,11 @@ function Add-VSPinpointSegmentSetDimension { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SetDimension resource property to the template. Specifies the dimension type and values for a segment. + Adds an AWS::Pinpoint::Segment.SetDimension resource property to the template. Specifies the dimension type and values for a segment dimension. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SetDimension resource property to the template. -Specifies the dimension type and values for a segment. +Specifies the dimension type and values for a segment dimension. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html @@ -18,7 +18,7 @@ Specifies the dimension type and values for a segment. UpdateType: Mutable .PARAMETER Values - The criteria values for the segment dimension to use. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. + The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 index 3672ad8e0..c99064d6a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSPinpointSegmentSourceSegments.ps1 @@ -1,26 +1,24 @@ function Add-VSPinpointSegmentSourceSegments { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment.SourceSegments resource property to the template. The base segment to build the segment on. A base segment, also called a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. + Adds an AWS::Pinpoint::Segment.SourceSegments resource property to the template. Specifies the base segment to build a segment on. A base segment, also referred to as a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. You can specify more than one dimensional segment or only one imported segment. .DESCRIPTION Adds an AWS::Pinpoint::Segment.SourceSegments resource property to the template. -The base segment to build the segment on. A base segment, also called a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. - -You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it. +Specifies the base segment to build a segment on. A base segment, also referred to as a *source segment*, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. You can specify more than one dimensional segment or only one imported segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups-sourcesegments.html .PARAMETER Version - The version number of the source segment. + The version number of the segment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups-sourcesegments.html#cfn-pinpoint-segment-segmentgroups-groups-sourcesegments-version PrimitiveType: Integer UpdateType: Mutable .PARAMETER Id - The unique ID of the source segment. + The unique identifier for the segment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups-groups-sourcesegments.html#cfn-pinpoint-segment-segmentgroups-groups-sourcesegments-id PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 index ba439efdc..6ba3b2561 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBClusterScalingConfiguration.ps1 @@ -22,7 +22,8 @@ If a DB cluster is paused for more than seven days, the DB cluster might be back .PARAMETER MaxCapacity The maximum capacity for an Aurora DB cluster in serverless DB engine mode. -Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity @@ -31,7 +32,8 @@ The maximum capacity must be greater than or equal to the minimum capacity. .PARAMETER MinCapacity The minimum capacity for an Aurora DB cluster in serverless DB engine mode. -Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 index 2d9fe26ee..af4aa1e8b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBInstanceDBInstanceRole.ps1 @@ -11,7 +11,7 @@ Describes an AWS Identity and Access Management (IAM role that is associated wit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html .PARAMETER FeatureName - The name of the feature associated with the AWS Identity and Access Management IAM role. For the list of supported feature names, see DBEngineVersion. + The name of the feature associated with the AWS Identity and Access Management IAM role. For the list of supported feature names, see DBEngineVersion: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html in the *Amazon RDS API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-featurename PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 index b49a33ec7..ea3fbbe4f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSDBSecurityGroupIngress.ps1 @@ -18,21 +18,21 @@ The Ingress property type specifies an individual ingress rule within an AWS::RD UpdateType: Mutable .PARAMETER EC2SecurityGroupId - Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupid PrimitiveType: String UpdateType: Immutable .PARAMETER EC2SecurityGroupName - Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupname PrimitiveType: String UpdateType: Immutable .PARAMETER EC2SecurityGroupOwnerId - AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupownerid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 index ca4c7bd84..62e488f4e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRDSOptionGroupOptionConfiguration.ps1 @@ -11,7 +11,7 @@ The OptionConfiguration property type specifies an individual option, and its se http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html .PARAMETER DBSecurityGroupMemberships - A list of DBSecurityGroupMemebrship name strings used for this option. + A list of DBSecurityGroupMembership name strings used for this option. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-dbsecuritygroupmemberships DuplicatesAllowed: True diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 index 1ee8f6cef..94ed60e8b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerRobotApplicationRobotSoftwareSuite.ps1 @@ -1,24 +1,24 @@ function Add-VSRoboMakerRobotApplicationRobotSoftwareSuite { <# .SYNOPSIS - Adds an AWS::RoboMaker::RobotApplication.RobotSoftwareSuite resource property to the template. Information about a robot software suite. + Adds an AWS::RoboMaker::RobotApplication.RobotSoftwareSuite resource property to the template. Information about a robot software suite (ROS distribution. .DESCRIPTION Adds an AWS::RoboMaker::RobotApplication.RobotSoftwareSuite resource property to the template. -Information about a robot software suite. +Information about a robot software suite (ROS distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html .PARAMETER Version - The version of the robot software suite. + The version of the robot software suite ROS distribution. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html#cfn-robomaker-robotapplication-robotsoftwaresuite-version PrimitiveType: String UpdateType: Mutable .PARAMETER Name - The name of the robot software suite. + The name of the robot software suite ROS distribution. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html#cfn-robomaker-robotapplication-robotsoftwaresuite-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 index 24202e6e3..79b5e722a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite.ps1 @@ -1,24 +1,24 @@ function Add-VSRoboMakerSimulationApplicationRobotSoftwareSuite { <# .SYNOPSIS - Adds an AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite resource property to the template. Information about a robot software suite. + Adds an AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite resource property to the template. Information about a robot software suite (ROS distribution. .DESCRIPTION Adds an AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite resource property to the template. -Information about a robot software suite. +Information about a robot software suite (ROS distribution. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html .PARAMETER Version - The version of the robot software suite. + The version of the robot software suite ROS distribution. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html#cfn-robomaker-simulationapplication-robotsoftwaresuite-version PrimitiveType: String UpdateType: Mutable .PARAMETER Name - The name of the robot software suite. + The name of the robot software suite ROS distribution. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html#cfn-robomaker-simulationapplication-robotsoftwaresuite-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 index b969744cd..c52ccf161 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckAlarmIdentifier.ps1 @@ -13,7 +13,7 @@ A complex type that identifies the CloudWatch alarm that you want Amazon Route 5 .PARAMETER Name The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. Route 53 supports CloudWatch alarms with the following features: -+ Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics in the *Amazon CloudWatch User Guide*. ++ Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics in the *Amazon CloudWatch User Guide*. + Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name @@ -22,7 +22,7 @@ Route 53 supports CloudWatch alarms with the following features: .PARAMETER Region For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. -For the current list of CloudWatch regions, see Amazon CloudWatch: http://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region in the *AWS Regions and Endpoints* chapter of the *Amazon Web Services General Reference*. +For the current list of CloudWatch regions, see Amazon CloudWatch: https://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region in the *AWS Service Endpoints* chapter of the *Amazon Web Services General Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 index 2ab358dd8..0bc5c337c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HealthCheckHealthCheckConfig.ps1 @@ -36,7 +36,7 @@ The SSL/TLS certificate on your endpoint includes a domain name in the Common Na UpdateType: Mutable .PARAMETER FailureThreshold - The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html in the *Amazon Route 53 Developer Guide*. + The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html in the *Amazon Route 53 Developer Guide*. If you don't specify a value for FailureThreshold, the default value is three health checks. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold @@ -54,9 +54,9 @@ When Route 53 checks the health of an endpoint, here is how it constructs the Ho If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases. **If you don't specify a value for IPAddress **: Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. -If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error. -If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server such as us-east-2-www.example.com, not the name of the resource record sets www.example.com. -In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. +If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error. +If you want to check the health of multiple records that have the same name and type, such as multiple weighted records, and if you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server such as us-east-2-www.example.com, not the name of the records www.example.com. +In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, health check results will be unpredictable. In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname @@ -116,7 +116,8 @@ You can't change the value of MeasureLatency after you create a health check. UpdateType: Immutable .PARAMETER Port - The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress. + The port on the endpoint that you want Amazon Route 53 to perform health checks on. +Don't specify a value for Port when you specify a value for Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type of CLOUDWATCH_METRIC or CALCULATED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port PrimitiveType: Integer @@ -150,7 +151,7 @@ If you don't specify a value for RequestInterval, the default value is 30 second UpdateType: Mutable .PARAMETER SearchString - If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. + If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. Route 53 considers case when searching for SearchString in the response body. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 index d4cd63891..ef7030065 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53HostedZoneVPC.ps1 @@ -1,24 +1,30 @@ function Add-VSRoute53HostedZoneVPC { <# .SYNOPSIS - Adds an AWS::Route53::HostedZone.VPC resource property to the template. (Private hosted zones only A complex type that contains information about an Amazon VPC. + Adds an AWS::Route53::HostedZone.VPC resource property to the template. *Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. .DESCRIPTION Adds an AWS::Route53::HostedZone.VPC resource property to the template. -(Private hosted zones only A complex type that contains information about an Amazon VPC. +*Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. + +**Note** + +For public hosted zones, omit VPCs, VPCId, and VPCRegion. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html .PARAMETER VPCId - Private hosted zones only The ID of an Amazon VPC. + *Private hosted zones only:* The ID of an Amazon VPC. +For public hosted zones, omit VPCs, VPCId, and VPCRegion. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcid PrimitiveType: String UpdateType: Mutable .PARAMETER VPCRegion - Private hosted zones only The region that an Amazon VPC was created in. + *Private hosted zones only:* The region that an Amazon VPC was created in. +For public hosted zones, omit VPCs, VPCId, and VPCRegion. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcregion PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 index 7dcd7d28e..71bf2ef60 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetAliasTarget.ps1 @@ -1,23 +1,23 @@ function Add-VSRoute53RecordSetAliasTarget { <# .SYNOPSIS - Adds an AWS::Route53::RecordSet.AliasTarget resource property to the template. *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. + Adds an AWS::Route53::RecordSet.AliasTarget resource property to the template. *Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. .DESCRIPTION Adds an AWS::Route53::RecordSet.AliasTarget resource property to the template. -*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. +*Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. -When creating resource record sets for a private hosted zone, note the following: +When creating records for a private hosted zone, note the following: -+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. ++ Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported. -+ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html. ++ For information about creating failover records in a private hosted zone, see Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html .PARAMETER DNSName - *Alias resource record sets only:* The value that you specify depends on where you want to route queries: + *Alias records only:* The value that you specify depends on where you want to route queries: Amazon API Gateway custom regional APIs and edge-optimized APIs Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html: + For regional APIs, specify the value of regionalDomainName. @@ -27,30 +27,37 @@ Amazon Virtual Private Cloud interface VPC endpoint Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. CloudFront distribution Specify the domain name that CloudFront assigned when you created your distribution. -Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names CNAMEs: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html in the *Amazon CloudFront Developer Guide*. -You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. +Your CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names CNAMEs: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html in the *Amazon CloudFront Developer Guide*. +You can't create a record in a private hosted zone to route traffic to a CloudFront distribution. For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. Elastic Beanstalk environment If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name. For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute: -+ *AWS Management Console*: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html in the *AWS Elastic Beanstalk Developer Guide*. -+ *Elastic Beanstalk API*: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments: http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html in the *AWS Elastic Beanstalk API Reference*. -+ *AWS CLI*: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html in the *AWS Command Line Interface Reference*. ++ *AWS Management Console*: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html in the *AWS Elastic Beanstalk Developer Guide*. ++ *Elastic Beanstalk API*: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html in the *AWS Elastic Beanstalk API Reference*. ++ *AWS CLI*: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments: https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html in the *AWS Command Line Interface Reference*. ELB load balancer Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. -+ **AWS Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. ++ **AWS Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. If you're routing traffic to a Classic Load Balancer, get the value that begins with **dualstack**. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. -+ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: -+ Classic Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html -+ Application and Network Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html -+ **AWS CLI**: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: -+ Classic Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html -+ Application and Network Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html ++ Application and Network Load Balancers: DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ++ **CloudFormation Fn::GetAtt intrinsic function**: Use the Fn::GetAtt: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html intrinsic function to get the value of DNSName: ++ Classic Load Balancers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values. ++ Application and Network Load Balancers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values. ++ **AWS CLI**: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html ++ Application and Network Load Balancers: describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html +AWS Global Accelerator accelerator +Specify the DNS name for your accelerator: ++ **Global Accelerator API**: To get the DNS name, use DescribeAccelerator: https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html. ++ **AWS CLI**: To get the DNS name, use describe-accelerator: https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html. Amazon S3 bucket that is configured as a static website -Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service S3 Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html in the *Amazon Route 53 Developer Guide.* -Another Route 53 resource record set -Specify the value of the Name element for a resource record set in the current hosted zone. +Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html in the *Amazon Route 53 Developer Guide.* +Another Route 53 record +Specify the value of the Name element for a record in the current hosted zone. If you're creating an alias record that has the same name as the hosted zone known as the zone apex, you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname @@ -58,7 +65,7 @@ If you're creating an alias record that has the same name as the hosted zone kno UpdateType: Mutable .PARAMETER EvaluateTargetHealth - *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone. + *Applies only to alias records with any routing policy:* When EvaluateTargetHealth is true, an alias record inherits the health of the referenced AWS resource, such as an ELB load balancer or another record in the hosted zone. Note the following: CloudFront distributions You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution. @@ -67,16 +74,16 @@ If you specify an Elastic Beanstalk environment in DNSName and the environment c If the environment contains a single Amazon EC2 instance, there are no special requirements. ELB load balancers Health checking behavior depends on the type of load balancer: -+ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. -+ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: ++ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. ++ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: + For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. + A target group that has no registered targets is considered unhealthy. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. S3 buckets There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket. Other records in the same hosted zone -If the AWS resource that you specify in DNSName is a record or a group of records for example, a group of weighted records but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks?: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting in the *Amazon Route 53 Developer Guide*. -For more information and examples, see Amazon Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html in the *Amazon Route 53 Developer Guide*. +If the AWS resource that you specify in DNSName is a record or a group of records for example, a group of weighted records but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks?: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting in the *Amazon Route 53 Developer Guide*. +For more information and examples, see Amazon Route 53 Health Checks and DNS Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html in the *Amazon Route 53 Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth PrimitiveType: Boolean @@ -91,24 +98,29 @@ Specify the hosted zone ID for your API. You can get the applicable value using Amazon Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. CloudFront distribution -Specify Z2FDTNDATAQYW2. -Alias resource record sets for CloudFront can't be created in a private zone. +Specify Z2FDTNDATAQYW2. This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution. +Alias records for CloudFront can't be created in a private zone. Elastic Beanstalk environment -Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk: http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. +Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk: https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. ELB load balancer Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: -+ Elastic Load Balancing: https://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. -+ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. -+ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: -+ Classic Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneNameId. -+ Application and Network Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneId. -+ **AWS CLI**: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: -+ Classic Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html to get the value of CanonicalHostedZoneNameId. -+ Application and Network Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html to get the value of CanonicalHostedZoneId. ++ Service Endpoints: https://docs.aws.amazon.com/general/latest/gr/elb.html table in the "Elastic Load Balancing Endpoints and Quotas" topic in the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. ++ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneId. ++ **CloudFormation Fn::GetAtt intrinsic function**: Use the Fn::GetAtt: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html intrinsic function to get the applicable value: ++ Classic Load Balancers: Get CanonicalHostedZoneNameID: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values. ++ Application and Network Load Balancers: Get CanonicalHostedZoneID: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values. ++ **AWS CLI**: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html to get the value of CanonicalHostedZoneId. +AWS Global Accelerator accelerator +Specify Z2BJ6XQ5FK7U4H. An Amazon S3 bucket configured as a static website -Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. -Another Route 53 resource record set in your hosted zone -Specify the hosted zone ID of your hosted zone. An alias resource record set can't reference a resource record set in a different hosted zone. +Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints in the *Amazon Web Services General Reference*. +Another Route 53 record in your hosted zone +Specify the hosted zone ID of your hosted zone. An alias record can't reference a record in a different hosted zone. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 index 32f5b5ece..d6b661506 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGeoLocation.ps1 @@ -11,8 +11,14 @@ A complex type that contains information about a geographic location. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html .PARAMETER ContinentCode - The two-letter code for the continent. -Valid values: AF | AN | AS | EU | OC | NA | SA + For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes: ++ **AF**: Africa ++ **AN**: Antarctica ++ **AS**: Asia ++ **EU**: Europe ++ **OC**: Oceania ++ **NA**: North America ++ **SA**: South America Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode @@ -20,14 +26,16 @@ Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode UpdateType: Mutable .PARAMETER CountryCode - The two-letter code for the country. + For geolocation resource record sets, the two-letter code for a country. +Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode PrimitiveType: String UpdateType: Mutable .PARAMETER SubdivisionCode - The code for the subdivision. Route 53 currently supports only states in the United States. + For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations: https://pe.usps.com/text/pub28/28apb.htm on the United States Postal Service website. +If you specify subdivisioncode, you must also specify US for CountryCode. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 index fa2b2a95b..e715f38fd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupAliasTarget.ps1 @@ -1,23 +1,23 @@ function Add-VSRoute53RecordSetGroupAliasTarget { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup.AliasTarget resource property to the template. *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. + Adds an AWS::Route53::RecordSetGroup.AliasTarget resource property to the template. *Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. .DESCRIPTION Adds an AWS::Route53::RecordSetGroup.AliasTarget resource property to the template. -*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. +*Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. -When creating resource record sets for a private hosted zone, note the following: +When creating records for a private hosted zone, note the following: -+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. ++ Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported. -+ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html. ++ For information about creating failover records in a private hosted zone, see Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html .PARAMETER DNSName - *Alias resource record sets only:* The value that you specify depends on where you want to route queries: + *Alias records only:* The value that you specify depends on where you want to route queries: Amazon API Gateway custom regional APIs and edge-optimized APIs Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html: + For regional APIs, specify the value of regionalDomainName. @@ -27,30 +27,37 @@ Amazon Virtual Private Cloud interface VPC endpoint Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. CloudFront distribution Specify the domain name that CloudFront assigned when you created your distribution. -Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names CNAMEs: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html in the *Amazon CloudFront Developer Guide*. -You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. +Your CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names CNAMEs: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html in the *Amazon CloudFront Developer Guide*. +You can't create a record in a private hosted zone to route traffic to a CloudFront distribution. For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. Elastic Beanstalk environment If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name. For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute: -+ *AWS Management Console*: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html in the *AWS Elastic Beanstalk Developer Guide*. -+ *Elastic Beanstalk API*: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments: http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html in the *AWS Elastic Beanstalk API Reference*. -+ *AWS CLI*: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html in the *AWS Command Line Interface Reference*. ++ *AWS Management Console*: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html in the *AWS Elastic Beanstalk Developer Guide*. ++ *Elastic Beanstalk API*: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html in the *AWS Elastic Beanstalk API Reference*. ++ *AWS CLI*: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments: https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html in the *AWS Command Line Interface Reference*. ELB load balancer Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. -+ **AWS Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. ++ **AWS Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. If you're routing traffic to a Classic Load Balancer, get the value that begins with **dualstack**. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. -+ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: -+ Classic Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html -+ Application and Network Load Balancers: DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html -+ **AWS CLI**: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: -+ Classic Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html -+ Application and Network Load Balancers: describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html ++ Application and Network Load Balancers: DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ++ **CloudFormation Fn::GetAtt intrinsic function**: Use the Fn::GetAtt: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html intrinsic function to get the value of DNSName: ++ Classic Load Balancers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values. ++ Application and Network Load Balancers: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values. ++ **AWS CLI**: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: ++ Classic Load Balancers: describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html ++ Application and Network Load Balancers: describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html +AWS Global Accelerator accelerator +Specify the DNS name for your accelerator: ++ **Global Accelerator API**: To get the DNS name, use DescribeAccelerator: https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html. ++ **AWS CLI**: To get the DNS name, use describe-accelerator: https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html. Amazon S3 bucket that is configured as a static website -Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service S3 Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html in the *Amazon Route 53 Developer Guide.* -Another Route 53 resource record set -Specify the value of the Name element for a resource record set in the current hosted zone. +Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html in the *Amazon Route 53 Developer Guide.* +Another Route 53 record +Specify the value of the Name element for a record in the current hosted zone. If you're creating an alias record that has the same name as the hosted zone known as the zone apex, you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname @@ -58,7 +65,7 @@ If you're creating an alias record that has the same name as the hosted zone kno UpdateType: Mutable .PARAMETER EvaluateTargetHealth - *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone. + *Applies only to alias records with any routing policy:* When EvaluateTargetHealth is true, an alias record inherits the health of the referenced AWS resource, such as an ELB load balancer or another record in the hosted zone. Note the following: CloudFront distributions You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution. @@ -67,16 +74,16 @@ If you specify an Elastic Beanstalk environment in DNSName and the environment c If the environment contains a single Amazon EC2 instance, there are no special requirements. ELB load balancers Health checking behavior depends on the type of load balancer: -+ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. -+ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: ++ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. ++ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: + For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. + A target group that has no registered targets is considered unhealthy. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. S3 buckets There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket. Other records in the same hosted zone -If the AWS resource that you specify in DNSName is a record or a group of records for example, a group of weighted records but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks?: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting in the *Amazon Route 53 Developer Guide*. -For more information and examples, see Amazon Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html in the *Amazon Route 53 Developer Guide*. +If the AWS resource that you specify in DNSName is a record or a group of records for example, a group of weighted records but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks?: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting in the *Amazon Route 53 Developer Guide*. +For more information and examples, see Amazon Route 53 Health Checks and DNS Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html in the *Amazon Route 53 Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth PrimitiveType: Boolean @@ -91,24 +98,29 @@ Specify the hosted zone ID for your API. You can get the applicable value using Amazon Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html. CloudFront distribution -Specify Z2FDTNDATAQYW2. -Alias resource record sets for CloudFront can't be created in a private zone. +Specify Z2FDTNDATAQYW2. This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution. +Alias records for CloudFront can't be created in a private zone. Elastic Beanstalk environment -Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk: http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. +Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk: https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. ELB load balancer Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: -+ Elastic Load Balancing: https://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. -+ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. -+ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: -+ Classic Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneNameId. -+ Application and Network Load Balancers: Use DescribeLoadBalancers: http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneId. -+ **AWS CLI**: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: -+ Classic Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html to get the value of CanonicalHostedZoneNameId. -+ Application and Network Load Balancers: Use describe-load-balancers: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html to get the value of CanonicalHostedZoneId. ++ Service Endpoints: https://docs.aws.amazon.com/general/latest/gr/elb.html table in the "Elastic Load Balancing Endpoints and Quotas" topic in the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. ++ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. ++ **Elastic Load Balancing API**: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use DescribeLoadBalancers: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html to get the value of CanonicalHostedZoneId. ++ **CloudFormation Fn::GetAtt intrinsic function**: Use the Fn::GetAtt: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html intrinsic function to get the applicable value: ++ Classic Load Balancers: Get CanonicalHostedZoneNameID: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values. ++ Application and Network Load Balancers: Get CanonicalHostedZoneID: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values. ++ **AWS CLI**: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: ++ Classic Load Balancers: Use describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html to get the value of CanonicalHostedZoneNameId. ++ Application and Network Load Balancers: Use describe-load-balancers: https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html to get the value of CanonicalHostedZoneId. +AWS Global Accelerator accelerator +Specify Z2BJ6XQ5FK7U4H. An Amazon S3 bucket configured as a static website -Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region table in the "AWS Regions and Endpoints" chapter of the *Amazon Web Services General Reference*. -Another Route 53 resource record set in your hosted zone -Specify the hosted zone ID of your hosted zone. An alias resource record set can't reference a resource record set in a different hosted zone. +Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints in the *Amazon Web Services General Reference*. +Another Route 53 record in your hosted zone +Specify the hosted zone ID of your hosted zone. An alias record can't reference a record in a different hosted zone. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 index b4727ea97..9c941a9e5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupGeoLocation.ps1 @@ -11,8 +11,14 @@ A complex type that contains information about a geographic location. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html .PARAMETER ContinentCode - The two-letter code for the continent. -Valid values: AF | AN | AS | EU | OC | NA | SA + For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes: ++ **AF**: Africa ++ **AN**: Antarctica ++ **AS**: Asia ++ **EU**: Europe ++ **OC**: Oceania ++ **NA**: North America ++ **SA**: South America Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode @@ -20,14 +26,16 @@ Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode UpdateType: Mutable .PARAMETER CountryCode - The two-letter code for the country. + For geolocation resource record sets, the two-letter code for a country. +Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode PrimitiveType: String UpdateType: Mutable .PARAMETER SubdivisionCode - The code for the subdivision. Route 53 currently supports only states in the United States. + For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations: https://pe.usps.com/text/pub28/28apb.htm on the United States Postal Service website. +If you specify subdivisioncode, you must also specify US for CountryCode. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 index 378a8b875..ce9df7f88 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSRoute53RecordSetGroupRecordSet.ps1 @@ -1,11 +1,13 @@ function Add-VSRoute53RecordSetGroupRecordSet { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup.RecordSet resource property to the template. Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. + Adds an AWS::Route53::RecordSetGroup.RecordSet resource property to the template. Information about the record that you want to create. .DESCRIPTION Adds an AWS::Route53::RecordSetGroup.RecordSet resource property to the template. -Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. +Information about the record that you want to create. + +The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. For more information, see ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html in the *Amazon Route 53 API Reference*. @@ -17,7 +19,7 @@ For more information, see ChangeResourceRecordSets: https://docs.aws.amazon.com/ If you're creating resource records sets for a private hosted zone, note the following: + You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. + Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. -+ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html in the *Amazon Route 53 Developer Guide*. ++ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html in the *Amazon Route 53 Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget Type: AliasTarget @@ -40,8 +42,8 @@ Except where noted, the following failover behaviors assume that you have includ You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets. For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true. For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: -+ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html -+ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html ++ Route 53 Health Checks and DNS Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover PrimitiveType: String @@ -49,11 +51,11 @@ For more information about configuring failover for Route 53, see the following .PARAMETER GeoLocation *Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF. -Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported. +Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported. If you create separate resource record sets for overlapping geographic regions for example, one resource record set for a continent and one for a country on the same continent, priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. You can't create two geolocation resource record sets that specify the same geographic location. The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements. -Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. +Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation @@ -69,8 +71,8 @@ Route 53 determines whether a resource record set is healthy based on one of the Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. For more information, see the following topics in the *Amazon Route 53 Developer Guide*: + How Amazon Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html -+ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html -+ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html ++ Route 53 Health Checks and DNS Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html **When to Specify HealthCheckId** Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: + **Non-alias resource record sets**: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type such as multiple weighted records named www.example.com with a type of A and you specify health check IDs for all the resource record sets. @@ -101,16 +103,17 @@ Health check results will be unpredictable if you do the following: UpdateType: Mutable .PARAMETER HostedZoneId - The ID of the hosted zone that contains the resource record sets that you want to change. + The ID of the hosted zone that you want to create records in. +Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid PrimitiveType: String UpdateType: Mutable .PARAMETER HostedZoneName - The name of the domain for the hosted zone where you want to add the resource record set. + The name of the hosted zone that you want to create records in. When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. -If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using HostedZoneId. +Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename PrimitiveType: String @@ -134,7 +137,7 @@ You can't create multivalue answer alias records. For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. **ChangeResourceRecordSets Only** Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com without a trailing dot and www.example.com. with a trailing dot as identical. -For information about how to specify characters other than a-z, 0-9, and - hyphen and how to specify internationalized domain names, see DNS Domain Name Format: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html in the *Amazon Route 53 Developer Guide*. +For information about how to specify characters other than a-z, 0-9, and - hyphen and how to specify internationalized domain names, see DNS Domain Name Format: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html in the *Amazon Route 53 Developer Guide*. You can use the asterisk * wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following: + The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com. + The * can't replace any of the middle labels, for example, marketing.*.example.com. @@ -149,7 +152,7 @@ You can use the * wildcard as the leftmost label in a domain name, for example, .PARAMETER Region *Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. -Creating latency and latency alias resource record sets in private hosted zones is not supported. +Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. Note the following: + You can only specify one ResourceRecord per latency resource record set. @@ -162,7 +165,11 @@ Note the following: UpdateType: Mutable .PARAMETER ResourceRecords - Information about the resource record sets that you want to add to the hosted zone. Each record should be in the format appropriate for the record type specified by the Type property. For information about different record types and their record formats, see Values That You Specify When You Create or Edit Amazon Route 53 Records: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html in the *Amazon Route 53 Developer Guide*. + One or more values that correspond with the value that you specified for the Type property. For example, if you specified A for Type, you specify one or more IP addresses in IPv4 format for ResourceRecords. For information about the format of values for each record type, see Supported DNS Resource Record Types: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. +Note the following: ++ You can specify more than one value for all record types except CNAME and SOA. ++ The maximum length of a value is 4000 characters. ++ If you're creating an alias record, omit ResourceRecords. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords DuplicatesAllowed: False @@ -190,7 +197,7 @@ For information about routing policies, see Choosing a Routing Policy: https://d UpdateType: Mutable .PARAMETER Type - The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. + The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT @@ -199,7 +206,7 @@ Values for alias resource record sets: + **Amazon API Gateway custom regional APIs and edge-optimized APIs:** A + **CloudFront distributions:** A If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA. -+ **AWS Elastic Beanstalk environment that has a regionalized subdomain**: A ++ **Amazon API Gateway environment that has a regionalized subdomain**: A + **ELB load balancers:** A | AAAA + **Amazon S3 buckets:** A + **Amazon Virtual Private Cloud interface VPC endpoints** A @@ -218,7 +225,7 @@ If you're creating an alias record that has the same name as the hosted zone kno + You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets. + You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements. + For weighted but not weighted alias resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. -The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html in the *Amazon Route 53 Developer Guide*. +The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html in the *Amazon Route 53 Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointPublicAccessBlockConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointPublicAccessBlockConfiguration.ps1 index b43262b90..7957ab15b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointPublicAccessBlockConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointPublicAccessBlockConfiguration.ps1 @@ -1,31 +1,46 @@ function Add-VSS3AccessPointPublicAccessBlockConfiguration { <# .SYNOPSIS - Adds an AWS::S3::AccessPoint.PublicAccessBlockConfiguration resource property to the template. + Adds an AWS::S3::AccessPoint.PublicAccessBlockConfiguration resource property to the template. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::AccessPoint.PublicAccessBlockConfiguration resource property to the template. - +The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html .PARAMETER BlockPublicAcls + Specifies whether Amazon S3 should block public access control lists ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: ++ PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. ++ PUT Object calls fail if the request includes a public ACL. ++ PUT Bucket calls fail if the request includes a public ACL. +Enabling this setting doesn't affect existing policies or ACLs. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicacls UpdateType: Immutable PrimitiveType: Boolean .PARAMETER IgnorePublicAcls + Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. +Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-ignorepublicacls UpdateType: Immutable PrimitiveType: Boolean .PARAMETER BlockPublicPolicy + Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. +Enabling this setting doesn't affect existing bucket policies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicpolicy UpdateType: Immutable PrimitiveType: Boolean .PARAMETER RestrictPublicBuckets + Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. +Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-restrictpublicbuckets UpdateType: Immutable PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointVpcConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointVpcConfiguration.ps1 index d180565de..331268362 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointVpcConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3AccessPointVpcConfiguration.ps1 @@ -1,16 +1,18 @@ function Add-VSS3AccessPointVpcConfiguration { <# .SYNOPSIS - Adds an AWS::S3::AccessPoint.VpcConfiguration resource property to the template. + Adds an AWS::S3::AccessPoint.VpcConfiguration resource property to the template. The Virtual Private Cloud (VPC configuration for this access point. .DESCRIPTION Adds an AWS::S3::AccessPoint.VpcConfiguration resource property to the template. - +The Virtual Private Cloud (VPC configuration for this access point. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html .PARAMETER VpcId + If this field is specified, the access point will only allow connections from the specified VPC ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html#cfn-s3-accesspoint-vpcconfiguration-vpcid UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 index 7bffebb64..c0383f53b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketAnalyticsConfiguration.ps1 @@ -7,8 +7,6 @@ function Add-VSS3BucketAnalyticsConfiguration { Adds an AWS::S3::Bucket.AnalyticsConfiguration resource property to the template. Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. -For more information, see GET Bucket analytics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETAnalyticsConfig.html in the *Amazon Simple Storage Service API Reference*. - .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 index 4c866a4dd..79ff5aa82 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketCorsConfiguration.ps1 @@ -11,7 +11,7 @@ Describes the cross-origin access configuration for objects in an Amazon S3 buck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html .PARAMETER CorsRules - A set of allowed origins and methods. + A set of origins and methods cross-origin access that you want to allow. You can add up to 100 rules to the configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html#cfn-s3-bucket-cors-corsrule DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 index 73140872b..cb190f529 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDefaultRetention.ps1 @@ -18,7 +18,7 @@ The default retention period that you want to apply to new objects placed in the UpdateType: Mutable .PARAMETER Mode - The default object lock retention mode you want to apply to new objects placed in the specified bucket. + The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-mode PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 index 2e5219277..abde1bd5b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketDestination.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketDestination { <# .SYNOPSIS - Adds an AWS::S3::Bucket.Destination resource property to the template. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket. + Adds an AWS::S3::Bucket.Destination resource property to the template. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC. .DESCRIPTION Adds an AWS::S3::Bucket.Destination resource property to the template. -Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket. +Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 index de77b3636..0b121529b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketEncryptionConfiguration.ps1 @@ -11,7 +11,7 @@ Specifies encryption-related information for an Amazon S3 bucket that is a desti http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html .PARAMETER ReplicaKmsKeyID - Specifies the AWS KMS Key ID Key ARN or Alias ARN for the destination bucket. Amazon S3 uses this key to encrypt replica objects. + Specifies the ID Key ARN or Alias ARN of the customer managed customer master key CMK stored in AWS Key Management Service KMS for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs. For more information, see Using Symmetric and Asymmetric Keys: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html in the *AWS Key Management Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html#cfn-s3-bucket-encryptionconfiguration-replicakmskeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 index 7c6872a57..ae992728b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketInventoryConfiguration.ps1 @@ -55,7 +55,7 @@ Specifies the inventory configuration for an Amazon S3 bucket. For more informat UpdateType: Mutable .PARAMETER ScheduleFrequency - Specifies the schedule for generating inventory results. + Specifies the schedule for generating inventory results. Valid Values: Daily | Weekly. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 index 303561661..3ef043c74 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNoncurrentVersionTransition.ps1 @@ -18,7 +18,7 @@ Container for the transition rule that describes when noncurrent objects transit UpdateType: Mutable .PARAMETER TransitionInDays - Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html in the *Amazon Simple Storage Service Developer Guide*. + Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-transitionindays PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 index 13825d56b..39fc01036 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketNotificationConfiguration.ps1 @@ -15,6 +15,8 @@ For example, you might use the AWS::Lambda::Permission resource to grant the buc To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. +For more information on permissions, see AWS::Lambda::Permission: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html and Granting Permissions to Publish Event Notification Messages to a Destination: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 index efdda0ba7..10420de5b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockConfiguration.ps1 @@ -1,24 +1,32 @@ function Add-VSS3BucketObjectLockConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket. + Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. .DESCRIPTION Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. -Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket. +Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. + +**Note** + +DefaultRetention requires either Days or Years. You can't specify both at the same time. + +**Related Resources** + ++ Locking Objects: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html .PARAMETER ObjectLockEnabled - Indicates whether this bucket has an object lock configuration enabled. + Indicates whether this bucket has an Object Lock configuration enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-objectlockenabled PrimitiveType: String UpdateType: Mutable .PARAMETER Rule - The object lock rule in place for the specified object. + The Object Lock rule in place for the specified object. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-rule Type: ObjectLockRule diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 index 15c14387e..28ce3de45 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketObjectLockRule.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketObjectLockRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. The object lock rule in place for the specified object. + Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. The Object Lock rule in place for the specified object. .DESCRIPTION Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. -The object lock rule in place for the specified object. +The Object Lock rule in place for the specified object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 index 6bf6240f7..aafe3ca62 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketPublicAccessBlockConfiguration.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketPublicAccessBlockConfiguration { <# .SYNOPSIS - Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. Specifies the Block Public Access configuration for an Amazon S3 bucket. + Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the Amazon Simple Storage Service Developer Guide. .DESCRIPTION Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. -Specifies the Block Public Access configuration for an Amazon S3 bucket. +The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the Amazon Simple Storage Service Developer Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html @@ -14,6 +14,7 @@ Specifies the Block Public Access configuration for an Amazon S3 bucket. Specifies whether Amazon S3 should block public access control lists ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: + PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. ++ PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicacls diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 index 00b582b3b..1abf06c71 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationConfiguration.ps1 @@ -11,7 +11,7 @@ A container for replication rules. You can add up to 1,000 rules. The maximum si http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html .PARAMETER Role - The Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Cross-Region Replication: https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-how-setup.html in the *Amazon Simple Storage Service Developer Guide*. + The Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-role PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 index 917e2921c..334b98ab0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationDestination.ps1 @@ -26,8 +26,7 @@ If you specify the AccessControlTranslation property, the Account property is re UpdateType: Mutable .PARAMETER Bucket - The Amazon Resource Name ARN of the bucket where you want Amazon S3 to store replicas of the object identified by the rule. -A replication configuration can replicate objects to only one destination bucket. If there are multiple rules in your replication configuration, all rules must specify the same destination bucket. + The Amazon Resource Name ARN of the bucket where you want Amazon S3 to store the results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-bucket PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 index f489fbeed..ccf560442 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketReplicationRule.ps1 @@ -11,7 +11,7 @@ Specifies which Amazon S3 objects to replicate and where to store the replicas. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html .PARAMETER Destination - A container for information about the replication destination. + A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control S3 RTC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-destination Type: ReplicationDestination @@ -25,14 +25,14 @@ Specifies which Amazon S3 objects to replicate and where to store the replicas. UpdateType: Mutable .PARAMETER Prefix - An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. + An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER SourceSelectionCriteria - A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key SSE-KMS. + A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key CMK stored in AWS Key Management Service SSE-KMS. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-sourceselectioncriteria Type: SourceSelectionCriteria diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 index 9af12fa6e..676e77b98 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRoutingRuleCondition.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketRoutingRuleCondition { <# .SYNOPSIS - Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. Specifies a condition that must be met for a redirect to apply. + Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. .DESCRIPTION Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. -Specifies a condition that must be met for a redirect to apply. +A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 index 0bbdd642a..8d2594516 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketRule.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketRule { <# .SYNOPSIS - Adds an AWS::S3::Bucket.Rule resource property to the template. Specifies lifecycle rules for an Amazon S3 bucket. For more information, see PUT Bucket lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. + Adds an AWS::S3::Bucket.Rule resource property to the template. Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. For examples, see Put Bucket Lifecycle Configuration Examples: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples .DESCRIPTION Adds an AWS::S3::Bucket.Rule resource property to the template. -Specifies lifecycle rules for an Amazon S3 bucket. For more information, see PUT Bucket lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. +Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. For examples, see Put Bucket Lifecycle Configuration Examples: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 index fa60fb3c3..d59f0bf94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketS3KeyFilter.ps1 @@ -11,7 +11,7 @@ A container for object key name prefix and suffix filtering rules. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html .PARAMETER Rules - A list of containers for the key value pair that defines the criteria for the filter rule. + A list of containers for the key-value pair that defines the criteria for the filter rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 index d91d2d527..f7959206d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketServerSideEncryptionByDefault.ps1 @@ -11,7 +11,12 @@ Describes the default server-side encryption to apply to new objects in the buck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html .PARAMETER KMSMasterKeyID - KMS master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms. + KMS key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms. +You can specify the key ID or the Amazon Resource Name ARN of the CMK. +For example: ++ Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab ++ Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab +Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html in the *AWS Key Management Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 index 3f76d78eb..ce71cd0eb 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSourceSelectionCriteria.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketSourceSelectionCriteria { <# .SYNOPSIS - Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS. + Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK stored in AWS Key Management Service (SSE-KMS. .DESCRIPTION Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. -A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS. +A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK stored in AWS Key Management Service (SSE-KMS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 index 3b5027f74..8989b3164 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketSseKmsEncryptedObjects.ps1 @@ -11,7 +11,7 @@ A container for filter information for the selection of S3 objects encrypted wit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html .PARAMETER Status - Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS-managed key. + Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key CMK stored in AWS Key Management Service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html#cfn-s3-bucket-ssekmsencryptedobjects-status PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 index f983825e1..2a89d6b82 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSS3BucketTransition.ps1 @@ -1,11 +1,11 @@ function Add-VSS3BucketTransition { <# .SYNOPSIS - Adds an AWS::S3::Bucket.Transition resource property to the template. Specifies when an object transitions to a specified storage class. + Adds an AWS::S3::Bucket.Transition resource property to the template. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.Transition resource property to the template. -Specifies when an object transitions to a specified storage class. +Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 index f33b77125..0f0dbe36c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESConfigurationSetEventDestinationEventDestination.ps1 @@ -1,17 +1,15 @@ function Add-VSSESConfigurationSetEventDestinationEventDestination { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination.EventDestination resource property to the template. Contains information about the event destination that the specified email sending events are published to. + Adds an AWS::SES::ConfigurationSetEventDestination.EventDestination resource property to the template. Contains information about the event destination that email sending events are published to. Event destinations are associated with configuration sets. When you specify an event destination, you provide one, and only one, destination. You can send event data to Amazon CloudWatch or Amazon Kinesis Data Firehose. For more information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. .DESCRIPTION Adds an AWS::SES::ConfigurationSetEventDestination.EventDestination resource property to the template. -Contains information about the event destination that the specified email sending events are published to. +Contains information about the event destination that email sending events are published to. Event destinations are associated with configuration sets. When you specify an event destination, you provide one, and only one, destination. You can send event data to Amazon CloudWatch or Amazon Kinesis Data Firehose. For more information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. **Note** -When you specify an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Data Firehose or Amazon Simple Notification Service (Amazon SNS. - -Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon Simple Notification Service (Amazon SNS. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. +You can't specify Amazon SNS event destinations in CloudFormation templates. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html @@ -40,8 +38,8 @@ Event destinations are associated with configuration sets, which enable you to p .PARAMETER Name The name of the event destination. The name must: -+ This value can only contain ASCII letters a-z, A-Z, numbers 0-9, underscores _, or dashes -. -+ Contain less than 64 characters. ++ This value can only contain ASCII letters a–z, A–Z, numbers 0–9, underscores _, or dashes -. ++ Contain fewer than 64 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 index 9fc9e4ada..80a17d34d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleBounceAction.ps1 @@ -34,7 +34,8 @@ For information about sending a bounce message in response to a received email, UpdateType: Mutable .PARAMETER TopicArn - The Amazon Resource Name ARN of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html operation in the Amazon SNS API. +For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-topicarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 index a80788a79..939784ffe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleLambdaAction.ps1 @@ -22,7 +22,8 @@ For information about using AWS Lambda actions in receipt rules, see the Amazon UpdateType: Mutable .PARAMETER TopicArn - The Amazon Resource Name ARN of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html operation in the Amazon SNS API. +For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-topicarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 index bc2224b1a..b4b184443 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleRule.ps1 @@ -22,7 +22,7 @@ For information about setting up receipt rules, see the Amazon SES Developer Gui UpdateType: Mutable .PARAMETER Recipients - Containts the recipient domains and email addresses that the receipt rule applies to. If this field isn't specified, this rule matches all recipients on all verified domains. + Contains the recipient domains and email addresses that the receipt rule applies to. If this field isn't specified, this rule matches all recipients on all verified domains. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 index ff78c9c23..b48ae44c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleS3Action.ps1 @@ -37,7 +37,8 @@ Your mail is encrypted by Amazon SES using the Amazon S3 encryption client befor UpdateType: Mutable .PARAMETER TopicArn - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html operation in the Amazon SNS API. +For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 index 44801f429..6dce03b2e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleSNSAction.ps1 @@ -19,7 +19,8 @@ For information about using a receipt rule to publish an Amazon SNS notification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html .PARAMETER TopicArn - The Amazon Resource Name ARN of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + The Amazon Resource Name ARN of the Amazon SNS topic to notify. You can find the ARN of a topic by using the ListTopics: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html operation in the Amazon SNS API. +For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 index b3873803a..1267e4f2c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleStopAction.ps1 @@ -13,14 +13,15 @@ For information about setting a stop action in a receipt rule, see the Amazon SE http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html .PARAMETER Scope - The name of the RuleSet that is being stopped. + The scope of the StopAction. The only acceptable value is RuleSet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-scope PrimitiveType: String UpdateType: Mutable .PARAMETER TopicArn - The Amazon Resource Name ARN of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html operation in the Amazon SNS API. +For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-topicarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 index d50058906..3b247273c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSESReceiptRuleWorkmailAction.ps1 @@ -13,14 +13,18 @@ For information using a receipt rule to call Amazon WorkMail, see the Amazon SES http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html .PARAMETER TopicArn - The Amazon Resource Name ARN of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. + The Amazon Resource Name ARN of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html operation in the Amazon SNS API. +For more information about Amazon SNS topics, see the Amazon SNS Developer Guide: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn PrimitiveType: String UpdateType: Mutable .PARAMETER OrganizationArn - The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide: https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html. + The Amazon Resource Name ARN of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: +arn:aws:workmail:::organization/ +You can find the ID of your organization by using the ListOrganizations: https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html operation in the Amazon WorkMail API. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters. +For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide: https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-organizationarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 index ba1b12578..8e9fe0fc7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSNSTopicSubscription.ps1 @@ -9,7 +9,7 @@ Subscription is an embedded property that describes the subscription endpoints o **Note** -For full control over subscription behavior such as delivery policy, filtering, raw message delivery, cross-region subscriptions, etc. use AWS::SNS::Subscription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html resource instead of this embedded property . +For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions, use the AWS::SNS::Subscription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 index 531a04524..2c8f87da1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMAssociationTarget.ps1 @@ -11,14 +11,14 @@ Target is a property of the AWS::SSM::Association: https://docs.aws.amazon.com/A http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html .PARAMETER Key - User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag: or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting in the *AWS Systems Manager User Guide*. + User-defined criteria for sending commands that target instances that meet the criteria. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key PrimitiveType: String UpdateType: Immutable .PARAMETER Values - User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html in the *AWS Systems Manager User Guide*. + User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 index a7461a313..687137371 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTargetTargets.ps1 @@ -13,7 +13,7 @@ Targets is a property of the AWS::SSM::MaintenanceWindowTarget: https://docs.aws http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html .PARAMETER Values - User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html in the *AWS Systems Manager User Guide*. + User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. PrimitiveItemType: String Type: List @@ -21,7 +21,7 @@ Targets is a property of the AWS::SSM::MaintenanceWindowTarget: https://docs.aws UpdateType: Mutable .PARAMETER Key - User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag: or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting in the *AWS Systems Manager User Guide*. + User-defined criteria for sending commands that target instances that meet the criteria. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 index 52e2a150e..ef9664d1f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters.ps1 @@ -1,11 +1,11 @@ function Add-VSSSMMaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters { <# .SYNOPSIS - Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters resource property to the template. The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for execution of the STEP_FUNCTION for a maintenance window task in AWS Systems Manager. + Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters resource property to the template. The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for the execution of a STEP_FUNCTIONS task in a Systems Manager maintenance window. .DESCRIPTION Adds an AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters resource property to the template. -The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for execution of the STEP_FUNCTION for a maintenance window task in AWS Systems Manager. +The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for the execution of a STEP_FUNCTIONS task in a Systems Manager maintenance window. MaintenanceWindowStepFunctionsParameters is a property of the TaskInvocationParameters: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html property type. @@ -13,14 +13,14 @@ MaintenanceWindowStepFunctionsParameters is a property of the TaskInvocationPara http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html .PARAMETER Input - The inputs for the STEP_FUNCTION task. + The inputs for the STEP_FUNCTIONS task. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input PrimitiveType: String UpdateType: Mutable .PARAMETER Name - The name of the STEP_FUNCTION task. + The name of the STEP_FUNCTIONS task. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 index 5cbb31685..154d03bc4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMMaintenanceWindowTaskTaskInvocationParameters.ps1 @@ -27,7 +27,7 @@ TaskInvocationParameters is a property of the AWS::SSM::MaintenanceWindowTask: h UpdateType: Mutable .PARAMETER MaintenanceWindowStepFunctionsParameters - The parameters for a STEP_FUNCTION task type. + The parameters for a STEP_FUNCTIONS task type. Type: MaintenanceWindowStepFunctionsParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 index e7ea69f44..fb3e1bb83 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMPatchBaselineRule.ps1 @@ -28,6 +28,7 @@ The PatchRules property of the RuleGroup: https://docs.aws.amazon.com/AWSCloudFo .PARAMETER ApproveAfterDays The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. +You must specify a value for ApproveAfterDays. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncAwsOrganizationsSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncAwsOrganizationsSource.ps1 index 4d9ef81b9..175ae4bd5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncAwsOrganizationsSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncAwsOrganizationsSource.ps1 @@ -1,21 +1,25 @@ function Add-VSSSMResourceDataSyncAwsOrganizationsSource { <# .SYNOPSIS - Adds an AWS::SSM::ResourceDataSync.AwsOrganizationsSource resource property to the template. + Adds an AWS::SSM::ResourceDataSync.AwsOrganizationsSource resource property to the template. Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations or, if an AWS Organization is not present, from multiple AWS Regions. .DESCRIPTION Adds an AWS::SSM::ResourceDataSync.AwsOrganizationsSource resource property to the template. - +Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations or, if an AWS Organization is not present, from multiple AWS Regions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html .PARAMETER OrganizationSourceType + If an AWS Organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire AWS Organization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationsourcetype PrimitiveType: String UpdateType: Immutable .PARAMETER OrganizationalUnits + The AWS Organizations organization units included in the sync. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationalunits diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncS3Destination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncS3Destination.ps1 index 6c708d111..193f11020 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncS3Destination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncS3Destination.ps1 @@ -1,36 +1,46 @@ function Add-VSSSMResourceDataSyncS3Destination { <# .SYNOPSIS - Adds an AWS::SSM::ResourceDataSync.S3Destination resource property to the template. + Adds an AWS::SSM::ResourceDataSync.S3Destination resource property to the template. Information about the target Amazon S3 bucket for the Resource Data Sync. .DESCRIPTION Adds an AWS::SSM::ResourceDataSync.S3Destination resource property to the template. - +Information about the target Amazon S3 bucket for the Resource Data Sync. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html .PARAMETER KMSKeyArn + The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-kmskeyarn PrimitiveType: String UpdateType: Immutable .PARAMETER BucketName + The name of the Amazon S3 bucket where the aggregated data is stored. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketname PrimitiveType: String UpdateType: Immutable .PARAMETER BucketRegion + The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketregion PrimitiveType: String UpdateType: Immutable .PARAMETER SyncFormat + A supported sync format. The following format is currently supported: JsonSerDe + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-syncformat PrimitiveType: String UpdateType: Immutable .PARAMETER BucketPrefix + An Amazon S3 prefix for the bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketprefix PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncSyncSource.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncSyncSource.ps1 index 698b61e29..f8e466099 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncSyncSource.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSSMResourceDataSyncSyncSource.ps1 @@ -1,31 +1,39 @@ function Add-VSSSMResourceDataSyncSyncSource { <# .SYNOPSIS - Adds an AWS::SSM::ResourceDataSync.SyncSource resource property to the template. + Adds an AWS::SSM::ResourceDataSync.SyncSource resource property to the template. Information about the source of the data included in the resource data sync. .DESCRIPTION Adds an AWS::SSM::ResourceDataSync.SyncSource resource property to the template. - +Information about the source of the data included in the resource data sync. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html .PARAMETER SourceType + The type of data source for the resource data sync. SourceType is either AwsOrganizations if an organization is present in AWS Organizations or singleAccountMultiRegions. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourcetype PrimitiveType: String UpdateType: Immutable .PARAMETER AwsOrganizationsSource + Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations. + Type: AwsOrganizationsSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-awsorganizationssource UpdateType: Mutable .PARAMETER IncludeFutureRegions + Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-includefutureregions PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SourceRegions + The SyncSource AWS Regions included in the resource data sync. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourceregions diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 index 2fe587030..0bc37f8f3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointConfigProductionVariant.ps1 @@ -1,11 +1,11 @@ function Add-VSSageMakerEndpointConfigProductionVariant { <# .SYNOPSIS - Adds an AWS::SageMaker::EndpointConfig.ProductionVariant resource property to the template. Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitiaVariantWeight objects. + Adds an AWS::SageMaker::EndpointConfig.ProductionVariant resource property to the template. Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitialVariantWeight objects. .DESCRIPTION Adds an AWS::SageMaker::EndpointConfig.ProductionVariant resource property to the template. -Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitiaVariantWeight objects. +Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitialVariantWeight objects. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html @@ -39,7 +39,7 @@ Specifies a model that you want to host and the resources to deploy for hosting UpdateType: Immutable .PARAMETER AcceleratorType - The size of the Elastic Inference EI instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker: http://docs.aws.amazon.com/sagemaker/latest/dg/ei.html. For more information, see Using Elastic Inference in Amazon SageMaker: http://docs.aws.amazon.com/sagemaker/latest/dg/ei.html. + The size of the Elastic Inference EI instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker: https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-acceleratortype PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointVariantProperty.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointVariantProperty.ps1 index 9c3fa9f27..6ba73c8b0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointVariantProperty.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerEndpointVariantProperty.ps1 @@ -1,16 +1,18 @@ function Add-VSSageMakerEndpointVariantProperty { <# .SYNOPSIS - Adds an AWS::SageMaker::Endpoint.VariantProperty resource property to the template. + Adds an AWS::SageMaker::Endpoint.VariantProperty resource property to the template. Not supported. .DESCRIPTION Adds an AWS::SageMaker::Endpoint.VariantProperty resource property to the template. - +Not supported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html .PARAMETER VariantPropertyType + Not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html#cfn-sagemaker-endpoint-variantproperty-variantpropertytype PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 index 0591d346b..df67fb62c 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelContainerDefinition.ps1 @@ -12,14 +12,14 @@ Describes the container, as part of model definition. .PARAMETER ContainerHostname This parameter is ignored for models that contain only a PrimaryContainer. -When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline: http://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline. +When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline: https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-containerhostname PrimitiveType: String UpdateType: Immutable .PARAMETER Mode - *Update requires*: Replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement + Whether the container hosts a single model or multiple models. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-mode PrimitiveType: String @@ -33,8 +33,8 @@ When a ContainerDefinition is part of an inference pipeline, the value of ths pa UpdateType: Immutable .PARAMETER ModelDataUrl - The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive .tar.gz suffix. The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters: http://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html. -If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html in the *AWS Identity and Access Management User Guide*. + The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive .tar.gz suffix. The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html. +If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html in the *AWS Identity and Access Management User Guide*. If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modeldataurl diff --git a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 index 84f572a21..ab1e24ea6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSageMakerModelVpcConfig.ps1 @@ -11,8 +11,7 @@ Specifies a VPC that your training jobs and hosted models have access to. Contro http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-vpcconfig.html .PARAMETER Subnets - The ID of the subnets in the VPC to which you want to connect your training job or model. -Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead. + The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones: https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 index 0813490d4..c49200dc2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerRotationScheduleRotationRules.ps1 @@ -1,11 +1,11 @@ function Add-VSSecretsManagerRotationScheduleRotationRules { <# .SYNOPSIS - Adds an AWS::SecretsManager::RotationSchedule.RotationRules resource property to the template. The RotationRules property is used as part of the AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type to configure how and when Secrets Manager performs rotation for the associated secret. + Adds an AWS::SecretsManager::RotationSchedule.RotationRules resource property to the template. The RotationRules property used as part of the AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type to configure how and when Secrets Manager performs rotation for the associated secret. .DESCRIPTION Adds an AWS::SecretsManager::RotationSchedule.RotationRules resource property to the template. -The RotationRules property is used as part of the AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type to configure how and when Secrets Manager performs rotation for the associated secret. +The RotationRules property used as part of the AWS::SecretsManager::RotationSchedule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type to configure how and when Secrets Manager performs rotation for the associated secret. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 index f18d97c53..9da3a4fd4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSSecretsManagerSecretGenerateSecretString.ps1 @@ -1,13 +1,13 @@ function Add-VSSecretsManagerSecretGenerateSecretString { <# .SYNOPSIS - Adds an AWS::SecretsManager::Secret.GenerateSecretString resource property to the template. Use the GenerateSecretStringproperty as part of the AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type to dynamically generate a random text string to use as a password. It is an alternative to hardcoding a password directly in the SecretString property. When you generate a AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type, you must include one or the other, but not both. + Adds an AWS::SecretsManager::Secret.GenerateSecretString resource property to the template. Use the GenerateSecretString property as part of the AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type to dynamically generate a random text string to use as a password. It is an alternative to hardcoding a password directly in the SecretString property. When you generate a AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type, you must include one or the other, but not both. .DESCRIPTION Adds an AWS::SecretsManager::Secret.GenerateSecretString resource property to the template. -Use the GenerateSecretStringproperty as part of the AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type to dynamically generate a random text string to use as a password. It is an alternative to hardcoding a password directly in the SecretString property. When you generate a AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type, you must include one or the other, but not both. +Use the GenerateSecretString property as part of the AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type to dynamically generate a random text string to use as a password. It is an alternative to hardcoding a password directly in the SecretString property. When you generate a AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html resource type, you must include one or the other, but not both. -SecretString enables you to place a literal value directly into the secret (a technique that we recommend you avoid. Instead, we recommend that you use the GenerateSecretString property to dynamically generate a random password. The operation returns a complete JSON structure to use as the secret value. The structure begins with the string that you supply using the SecretStringTemplate. This template string must be a properly formatted JSON string that contains all of the secret value information except the password. The operation then generates a random password using the rules specified by the other parameters. Finally, the operations inserts the generated password into the secret value structure along with the JSON key name that's specified by the GenerateStringKey parameter. +SecretString enables you to place a literal value directly into the secret, an action not recommended. Instead, we recommend that you use the GenerateSecretString property to dynamically generate a random password. The operation returns a complete JSON structure to use as the secret value. The structure begins with the string you supply using the SecretStringTemplate. This template string must be a properly formatted JSON string that contains all of the secret value information except the password. The operation then generates a random password using the rules specified by the other parameters. Finally, the operations inserts the generated password into the secret value structure along with the JSON key name specified by the GenerateStringKey parameter. For examples, see AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html. @@ -15,35 +15,35 @@ For examples, see AWS::SecretsManager::Secret: https://docs.aws.amazon.com/AWSCl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html .PARAMETER ExcludeUppercase - Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is False, and the generated password can include uppercase letters. + Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludeuppercase PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RequireEachIncludedType - Specifies whether the generated password must include at least one of every allowed character type. If you don't include this switch, the default value is True, and the generated password includes at least one of every character type. + Specifies whether the generated password must include at least one of every allowed character type. The default value is True, and the generated password includes at least one of every character type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-requireeachincludedtype PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IncludeSpace - Specifies that the generated password can include the space character. The default if you do not include this switch parameter is False, and the generated password doesn't include space characters. + Specifies that the generated password can include the space character. The default parameter is False, and the generated password doesn't include space characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-includespace PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ExcludeCharacters - A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters. + A string that excludes characters in the generated password. The default value is that all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludecharacters PrimitiveType: String UpdateType: Mutable .PARAMETER GenerateStringKey - The JSON key name that's used to add the generated password to the JSON structure specified by the SecretStringTemplateparameter. If you specify this parameter, then you must also specify SecretStringTemplate. + The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-generatestringkey PrimitiveType: String @@ -66,21 +66,21 @@ The following are the punctuation characters that *can* be included in the gener UpdateType: Mutable .PARAMETER ExcludeLowercase - Specifies that the generated password should not include lowercase letters. The default if you don't include this switch parameter is False, and the generated password can include lowercase letters. + Specifies the generated password should not include lowercase letters. The default parameter is False, and the generated password can include lowercase letters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludelowercase PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SecretStringTemplate - A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey. That key is combined with the generated random string and inserted into the JSON structure that's specified by this parameter. The merged JSON string is returned as the completed SecretStringof the secret. The default if you don't include this parameter is that the generated random password string is returned by itself, and isn't embeded in a JSON structure. + A properly structured JSON string where you can the generated password. If you specify this parameter, then you must also specify GenerateStringKey. The key is combined with the generated random string and inserted into the JSON structure specified by this parameter. The merged JSON string is returned as the completed SecretString of the secret. The default value for the generated random password string is returned by itself, and isn't embeded in a JSON structure. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-secretstringtemplate PrimitiveType: String UpdateType: Mutable .PARAMETER ExcludeNumbers - Specifies that the generated password should not include digits. The default if you don't include this switch parameter is False, and the generated password can include digits. + Specifies that the generated password should exclude digits. The default is False, and the generated password can include digits. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludenumbers PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 index ffee0996b..7ec1b089e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceDnsConfig.ps1 @@ -39,6 +39,7 @@ For more information about the weighted routing policy, see Weighted Routing: ht .PARAMETER NamespaceId The ID of the namespace to use for DNS configuration. +You must specify a value for NamespaceId either for DnsConfig or for the service properties: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html. Don't specify a value in both places. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-namespaceid PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 index 8739e02e2..8bcaf505b 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckConfig.ps1 @@ -1,11 +1,11 @@ function Add-VSServiceDiscoveryServiceHealthCheckConfig { <# .SYNOPSIS - Adds an AWS::ServiceDiscovery::Service.HealthCheckConfig resource property to the template. *Public DNS namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. + Adds an AWS::ServiceDiscovery::Service.HealthCheckConfig resource property to the template. *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. .DESCRIPTION Adds an AWS::ServiceDiscovery::Service.HealthCheckConfig resource property to the template. -*Public DNS namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. +*Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. **Important** diff --git a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 index 515254135..a6d464003 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSServiceDiscoveryServiceHealthCheckCustomConfig.ps1 @@ -39,8 +39,6 @@ AWS Cloud Map doesn't check the health of the resource directly. 1. If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource. -Note the following about configuring custom health checks. - .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html diff --git a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineCloudWatchLogsLogGroup.ps1 b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineCloudWatchLogsLogGroup.ps1 index 4e3f95fe5..2421b2184 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineCloudWatchLogsLogGroup.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineCloudWatchLogsLogGroup.ps1 @@ -1,16 +1,22 @@ function Add-VSStepFunctionsStateMachineCloudWatchLogsLogGroup { <# .SYNOPSIS - Adds an AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup resource property to the template. + Adds an AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup resource property to the template. Defines a CloudWatch log group. .DESCRIPTION Adds an AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup resource property to the template. +Defines a CloudWatch log group. +**Note** + +CloudWatchLogsLogGroup is only valid when StateMachineType is set to EXPRESS. For more information see Standard Versus Express Workflows: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html in the AWS Step Functions Developer Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup.html .PARAMETER LogGroupArn + The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup.html#cfn-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup-loggrouparn PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLogDestination.ps1 b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLogDestination.ps1 index 4b9efec92..fecc4fa51 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLogDestination.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLogDestination.ps1 @@ -1,16 +1,22 @@ function Add-VSStepFunctionsStateMachineLogDestination { <# .SYNOPSIS - Adds an AWS::StepFunctions::StateMachine.LogDestination resource property to the template. + Adds an AWS::StepFunctions::StateMachine.LogDestination resource property to the template. Defines a destination for LoggingConfiguration. .DESCRIPTION Adds an AWS::StepFunctions::StateMachine.LogDestination resource property to the template. +Defines a destination for LoggingConfiguration. +**Note** + +LogDestination is only valid when StateMachineType is set to EXPRESS. For more information on logging with EXPRESS workflows, see Logging Express Workflows Using CloudWatch Logs: https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html .PARAMETER CloudWatchLogsLogGroup + An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html in the AWS CloudFormation User Guide. + Type: CloudWatchLogsLogGroup Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html#cfn-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLoggingConfiguration.ps1 b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLoggingConfiguration.ps1 index 8bb816143..ad3189acc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLoggingConfiguration.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSStepFunctionsStateMachineLoggingConfiguration.ps1 @@ -1,27 +1,37 @@ function Add-VSStepFunctionsStateMachineLoggingConfiguration { <# .SYNOPSIS - Adds an AWS::StepFunctions::StateMachine.LoggingConfiguration resource property to the template. + Adds an AWS::StepFunctions::StateMachine.LoggingConfiguration resource property to the template. Defines what execution history events are logged and where they are logged. .DESCRIPTION Adds an AWS::StepFunctions::StateMachine.LoggingConfiguration resource property to the template. +Defines what execution history events are logged and where they are logged. +**Note** + +The loggingConfiguration parameter is only valid when type is set to EXPRESS. By default, the level is set to OFF. For more information see Log Levels: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html in the AWS Step Functions User Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html .PARAMETER IncludeExecutionData + Determines whether execution data is included in your log. When set to FALSE, data is excluded. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-includeexecutiondata PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Destinations + An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-destinations ItemType: LogDestination UpdateType: Mutable .PARAMETER Level + Defines which category of execution history events are logged. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-level PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 b/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 index 78d0add7f..ddc4167bd 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSTag.ps1 @@ -27,14 +27,14 @@ All stack-level tags, including automatically created tags, are propagated to re http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html .PARAMETER Key - The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html#cfn-resource-tags-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value - The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html#cfn-resource-tags-value PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 b/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 index 5bd34ca77..84b68f7c7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSTransferServerEndpointDetails.ps1 @@ -1,17 +1,22 @@ function Add-VSTransferServerEndpointDetails { <# .SYNOPSIS - Adds an AWS::Transfer::Server.EndpointDetails resource property to the template. The virtual private cloud (VPC endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter. + Adds an AWS::Transfer::Server.EndpointDetails resource property to the template. The virtual private cloud (VPC endpoint settings that are configured for your SFTP server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. You VPC's default security groups are automatically assigned to your endpoint. .DESCRIPTION Adds an AWS::Transfer::Server.EndpointDetails resource property to the template. -The virtual private cloud (VPC endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter. +The virtual private cloud (VPC endpoint settings that are configured for your SFTP server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. You VPC's default security groups are automatically assigned to your endpoint. + +**Note** + +It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html .PARAMETER AddressAllocationIds - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API. +This property can only be used when EndpointType is set to VPC. PrimitiveItemType: String Type: List @@ -19,7 +24,8 @@ The virtual private cloud (VPC endpoint settings that you want to configure for UpdateType: Conditional .PARAMETER VpcId - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted. +This property can only be used when EndpointType is set to VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcid PrimitiveType: String @@ -27,13 +33,15 @@ The virtual private cloud (VPC endpoint settings that you want to configure for .PARAMETER VpcEndpointId The ID of the VPC endpoint. +This property can only be used when EndpointType is set to VPC_ENDPOINT. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcendpointid PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds - *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt + A list of subnet IDs that are required to host your SFTP server endpoint in your VPC. +This property can only be used when EndpointType is set to VPC. PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSTransferUserHomeDirectoryMapEntry.ps1 b/VaporShell/Public/Resource Property Types/Add-VSTransferUserHomeDirectoryMapEntry.ps1 index 92ee394ca..25f9fd072 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSTransferUserHomeDirectoryMapEntry.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSTransferUserHomeDirectoryMapEntry.ps1 @@ -1,21 +1,25 @@ function Add-VSTransferUserHomeDirectoryMapEntry { <# .SYNOPSIS - Adds an AWS::Transfer::User.HomeDirectoryMapEntry resource property to the template. + Adds an AWS::Transfer::User.HomeDirectoryMapEntry resource property to the template. Represents an object that contains entries and targets for HomeDirectoryMappings. .DESCRIPTION Adds an AWS::Transfer::User.HomeDirectoryMapEntry resource property to the template. - +Represents an object that contains entries and targets for HomeDirectoryMappings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html .PARAMETER Entry + Represents an entry and a target for HomeDirectoryMappings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-entry PrimitiveType: String UpdateType: Mutable .PARAMETER Target + Represents the map target that is used in a HomeDirectorymapEntry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-target PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 index b155a38c3..a3c1170bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetByteMatchTuple.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFByteMatchSetByteMatchTuple { <# .SYNOPSIS - Adds an AWS::WAF::ByteMatchSet.ByteMatchTuple resource property to the template. The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. + Adds an AWS::WAF::ByteMatchSet.ByteMatchTuple resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::ByteMatchSet.ByteMatchTuple resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. .LINK @@ -66,7 +72,7 @@ Valid values depend on the Type value in the FieldToMatch property. For example, UpdateType: Mutable .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 index c6cfc4ce4..65a6faba0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFByteMatchSetFieldToMatch.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFByteMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAF::ByteMatchSet.FieldToMatch resource property to the template. Specifies where in a web request to look for TargetString. + Adds an AWS::WAF::ByteMatchSet.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::ByteMatchSet.FieldToMatch resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies where in a web request to look for TargetString. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 index 2e56da3ed..b04616995 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFIPSetIPSetDescriptor.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFIPSetIPSetDescriptor { <# .SYNOPSIS - Adds an AWS::WAF::IPSet.IPSetDescriptor resource property to the template. Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. + Adds an AWS::WAF::IPSet.IPSetDescriptor resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::IPSet.IPSetDescriptor resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 index 60d86cf28..6e2c8a891 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetByteMatchTuple.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFRegionalByteMatchSetByteMatchTuple { <# .SYNOPSIS - Adds an AWS::WAFRegional::ByteMatchSet.ByteMatchTuple resource property to the template. The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. + Adds an AWS::WAFRegional::ByteMatchSet.ByteMatchTuple resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::ByteMatchSet.ByteMatchTuple resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + The bytes (typically a string that corresponds with ASCII characters that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. .LINK @@ -59,7 +65,7 @@ The value of TargetString must appear at the end of the specified part of the we UpdateType: Mutable .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 index 96fbb8d1f..1c419ebfe 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalByteMatchSetFieldToMatch.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFRegionalByteMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFRegional::ByteMatchSet.FieldToMatch resource property to the template. Specifies where in a web request to look for TargetString. + Adds an AWS::WAFRegional::ByteMatchSet.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::ByteMatchSet.FieldToMatch resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies where in a web request to look for TargetString. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 index 5078d388c..943a39313 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFRegionalGeoMatchSetGeoMatchConstraint { <# .SYNOPSIS - Adds an AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint resource property to the template. The country from which web requests originate that you want AWS WAF to search for. + Adds an AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + The country from which web requests originate that you want AWS WAF to search for. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 index c34f6c550..834d714da 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalIPSetIPSetDescriptor.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFRegionalIPSetIPSetDescriptor { <# .SYNOPSIS - Adds an AWS::WAFRegional::IPSet.IPSetDescriptor resource property to the template. Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. + Adds an AWS::WAFRegional::IPSet.IPSetDescriptor resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::IPSet.IPSetDescriptor resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies the IP address type (IPV4 or IPV6 and the IP address range (in CIDR format that web requests originate from. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 index bd9517a42..76b713ec1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSizeConstraintSetSizeConstraint.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFRegionalSizeConstraintSetSizeConstraint { <# .SYNOPSIS - Adds an AWS::WAFRegional::SizeConstraintSet.SizeConstraint resource property to the template. Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. + Adds an AWS::WAFRegional::SizeConstraintSet.SizeConstraint resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::SizeConstraintSet.SizeConstraint resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. .LINK @@ -33,7 +39,7 @@ If you specify URI for the value of Type, the / in the URI counts as one charact UpdateType: Mutable .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. **NONE** diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 index ae2b70867..a5aff9c0f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 @@ -1,17 +1,23 @@ function Add-VSWAFRegionalSqlInjectionMatchSetSqlInjectionMatchTuple { <# .SYNOPSIS - Adds an AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. + Adds an AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 index 465ff1ea1..d7a90feab 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFRegionalXssMatchSetXssMatchTuple.ps1 @@ -1,17 +1,23 @@ function Add-VSWAFRegionalXssMatchSetXssMatchTuple { <# .SYNOPSIS - Adds an AWS::WAFRegional::XssMatchSet.XssMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. + Adds an AWS::WAFRegional::XssMatchSet.XssMatchTuple resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFRegional::XssMatchSet.XssMatchTuple resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 index f350205fe..937598b12 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSizeConstraintSetSizeConstraint.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFSizeConstraintSetSizeConstraint { <# .SYNOPSIS - Adds an AWS::WAF::SizeConstraintSet.SizeConstraint resource property to the template. Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. + Adds an AWS::WAF::SizeConstraintSet.SizeConstraint resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::SizeConstraintSet.SizeConstraint resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. .LINK @@ -40,7 +46,7 @@ If you specify URI for the value of Type, the / in the URI counts as one charact UpdateType: Mutable .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. **NONE** diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 index c136e5889..a5140925f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetFieldToMatch.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFSqlInjectionMatchSetFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAF::SqlInjectionMatchSet.FieldToMatch resource property to the template. Specifies where in a web request to look for TargetString. + Adds an AWS::WAF::SqlInjectionMatchSet.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::SqlInjectionMatchSet.FieldToMatch resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies where in a web request to look for TargetString. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 index 76da16727..a6b2db4b2 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFSqlInjectionMatchSetSqlInjectionMatchTuple { <# .SYNOPSIS - Adds an AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. + Adds an AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. .LINK @@ -18,7 +24,7 @@ Specifies the part of a web request that you want AWS WAF to inspect for snippet UpdateType: Mutable .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 index 700527dd6..ca8883f36 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFWebACLWafAction.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFWebACLWafAction { <# .SYNOPSIS - Adds an AWS::WAF::WebACL.WafAction resource property to the template. For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL. + Adds an AWS::WAF::WebACL.WafAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::WebACL.WafAction resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL. .LINK diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 index 5f69d4624..dd81b83a0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFXssMatchSetXssMatchTuple.ps1 @@ -1,10 +1,16 @@ function Add-VSWAFXssMatchSetXssMatchTuple { <# .SYNOPSIS - Adds an AWS::WAF::XssMatchSet.XssMatchTuple resource property to the template. Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. + Adds an AWS::WAF::XssMatchSet.XssMatchTuple resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAF::XssMatchSet.XssMatchTuple resource property to the template. +**Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. .LINK @@ -18,7 +24,7 @@ Specifies the part of a web request that you want AWS WAF to inspect for cross-s UpdateType: Mutable .PARAMETER TextTransformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 index 3fa1c859f..154548967 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementOne.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2RuleGroupAndStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.AndStatementOne resource property to the template. + Adds an AWS::WAFv2::RuleGroup.AndStatementOne resource property to the template. Logical AND statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.AndStatementOne resource property to the template. - +Logical AND statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementone.html .PARAMETER Statements + Logical AND statements used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementone.html#cfn-wafv2-rulegroup-andstatementone-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 index 047608053..7823758e4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupAndStatementTwo.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2RuleGroupAndStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.AndStatementTwo resource property to the template. + Adds an AWS::WAFv2::RuleGroup.AndStatementTwo resource property to the template. Logical AND statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.AndStatementTwo resource property to the template. - +Logical AND statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementtwo.html .PARAMETER Statements + Logical AND statements used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementtwo.html#cfn-wafv2-rulegroup-andstatementtwo-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 index 0a9c4e383..0645e37b7 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupByteMatchStatement.ps1 @@ -1,37 +1,67 @@ function Add-VSWAFv2RuleGroupByteMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.ByteMatchStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.ByteMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.ByteMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html .PARAMETER SearchString + A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive. +Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you. +For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you provide the string BadBot in the value of SearchString. +You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstring UpdateType: Mutable PrimitiveType: String .PARAMETER SearchStringBase64 + String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in SearchString instead. +You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstringbase64 UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .PARAMETER PositionalConstraint + The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following: +**CONTAINS** +The specified part of the web request must include the value of SearchString, but the location doesn't matter. +**CONTAINS_WORD** +The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore A-Z, a-z, 0-9, or _. In addition, SearchString must be a word, which means that both of the following are true: ++ SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore _. Examples include the value of a header and ;BadBot. ++ SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore _, for example, BadBot; and -BadBot;. +**EXACTLY** +The value of the specified part of the web request must exactly match the value of SearchString. +**STARTS_WITH** +The value of SearchString must appear at the beginning of the specified part of the web request. +**ENDS_WITH** +The value of SearchString must appear at the end of the specified part of the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-positionalconstraint UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 index 751b20af0..cb9edca60 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupFieldToMatch.ps1 @@ -1,46 +1,65 @@ function Add-VSWAFv2RuleGroupFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.FieldToMatch resource property to the template. + Adds an AWS::WAFv2::RuleGroup.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.FieldToMatch resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html .PARAMETER SingleHeader + Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singleheader UpdateType: Mutable PrimitiveType: Json .PARAMETER SingleQueryArgument + Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singlequeryargument UpdateType: Mutable PrimitiveType: Json .PARAMETER AllQueryArguments + Inspect all query arguments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-allqueryarguments UpdateType: Mutable PrimitiveType: Json .PARAMETER UriPath + Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-uripath UpdateType: Mutable PrimitiveType: Json .PARAMETER QueryString + Inspect the query string. This is the part of a URL that appears after a ? character, if any. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-querystring UpdateType: Mutable PrimitiveType: Json .PARAMETER Body + Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. +Note that only the first 8 KB 8192 bytes of the request body are forwarded to AWS WAF for inspection. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-body UpdateType: Mutable PrimitiveType: Json .PARAMETER Method + Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-method UpdateType: Mutable PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 index 6caa84660..df6050776 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupGeoMatchStatement.ps1 @@ -1,16 +1,22 @@ function Add-VSWAFv2RuleGroupGeoMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.GeoMatchStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.GeoMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.GeoMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to identify web requests based on country of origin. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html .PARAMETER CountryCodes + An array of two-character country codes, for example, "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-countrycodes UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 index 8de4f309c..0ed509038 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupIPSetReferenceStatement.ps1 @@ -1,16 +1,24 @@ function Add-VSWAFv2RuleGroupIPSetReferenceStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.IPSetReferenceStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.IPSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.IPSetReferenceStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. + +Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html .PARAMETER Arn + The Amazon Resource Name ARN of the IPSet that this statement references. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 index e5ce2ac3d..e5acc8df8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementOne.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2RuleGroupNotStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.NotStatementOne resource property to the template. + Adds an AWS::WAFv2::RuleGroup.NotStatementOne resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.NotStatementOne resource property to the template. - +Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementone.html .PARAMETER Statement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementone.html#cfn-wafv2-rulegroup-notstatementone-statement UpdateType: Mutable Type: StatementTwo diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 index f53b0714c..4cd1d34bc 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupNotStatementTwo.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2RuleGroupNotStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.NotStatementTwo resource property to the template. + Adds an AWS::WAFv2::RuleGroup.NotStatementTwo resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.NotStatementTwo resource property to the template. - +Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementtwo.html .PARAMETER Statement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementtwo.html#cfn-wafv2-rulegroup-notstatementtwo-statement UpdateType: Mutable Type: StatementThree diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 index 8b55a33f0..fc2e4770a 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementOne.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2RuleGroupOrStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.OrStatementOne resource property to the template. + Adds an AWS::WAFv2::RuleGroup.OrStatementOne resource property to the template. Logical OR statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.OrStatementOne resource property to the template. - +Logical OR statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementone.html .PARAMETER Statements + Logical OR statements. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementone.html#cfn-wafv2-rulegroup-orstatementone-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 index e2a29eda7..430341268 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupOrStatementTwo.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2RuleGroupOrStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.OrStatementTwo resource property to the template. + Adds an AWS::WAFv2::RuleGroup.OrStatementTwo resource property to the template. Logical OR statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.OrStatementTwo resource property to the template. - +Logical OR statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementtwo.html .PARAMETER Statements + Logical OR statements used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementtwo.html#cfn-wafv2-rulegroup-orstatementtwo-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 index f76c42aea..1c1d3e39d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementOne.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2RuleGroupRateBasedStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.RateBasedStatementOne resource property to the template. + Adds an AWS::WAFv2::RuleGroup.RateBasedStatementOne resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RateBasedStatementOne resource property to the template. +A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. + +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html .PARAMETER Limit + Limit on the web request that match any nested statement criteria in any 5 minute period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType + Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement + Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-scopedownstatement UpdateType: Mutable Type: StatementTwo diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 index 33b6d6e0a..c4bac6d10 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRateBasedStatementTwo.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2RuleGroupRateBasedStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.RateBasedStatementTwo resource property to the template. + Adds an AWS::WAFv2::RuleGroup.RateBasedStatementTwo resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RateBasedStatementTwo resource property to the template. +A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. + +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html .PARAMETER Limit + Limit on the web request that match any nested statement criteria in any 5 minute period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType + Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement + Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-scopedownstatement UpdateType: Mutable Type: StatementThree diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 index af053d3e2..3d7ef7a53 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement.ps1 @@ -1,26 +1,38 @@ function Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. + +Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html .PARAMETER Arn + The Amazon Resource Name ARN of the RegexPatternSet that this statement references. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 index 066166804..0e49a71d3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRule.ps1 @@ -1,36 +1,50 @@ function Add-VSWAFv2RuleGroupRule { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.Rule resource property to the template. + Adds an AWS::WAFv2::RuleGroup.Rule resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.Rule resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html .PARAMETER Name + A friendly name of the rule. You can't change the name of a Rule after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-name UpdateType: Mutable PrimitiveType: String .PARAMETER Priority + If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Statement + The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-statement UpdateType: Mutable Type: StatementOne .PARAMETER Action + The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-action UpdateType: Mutable Type: RuleAction .PARAMETER VisibilityConfig + Defines and enables Amazon CloudWatch metrics and web request sample collection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-visibilityconfig UpdateType: Mutable Type: VisibilityConfig diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 index 817cc232b..adacf1b9d 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupRuleAction.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2RuleGroupRuleAction { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.RuleAction resource property to the template. + Adds an AWS::WAFv2::RuleGroup.RuleAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RuleAction resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html .PARAMETER Allow + Instructs AWS WAF to allow the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-allow UpdateType: Mutable PrimitiveType: Json .PARAMETER Block + Instructs AWS WAF to block the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-block UpdateType: Mutable PrimitiveType: Json .PARAMETER Count + Instructs AWS WAF to count the web request and allow it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-count UpdateType: Mutable PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 index 509490394..8cbfbad93 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSizeConstraintStatement.ps1 @@ -1,31 +1,47 @@ function Add-VSWAFv2RuleGroupSizeConstraintStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.SizeConstraintStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.SizeConstraintStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.SizeConstraintStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (> or less than (<. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. + +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. + +If you choose URI for the value of Part of the request to filter on, the slash (/ in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER ComparisonOperator + The operator to use to compare the request part to the size setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-comparisonoperator UpdateType: Mutable PrimitiveType: String .PARAMETER Size + The size, in byte, to compare to the request part, after any transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-size UpdateType: Mutable PrimitiveType: Integer .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 index 5d3e46dd8..d23b1204e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupSqliMatchStatement.ps1 @@ -1,21 +1,29 @@ function Add-VSWAFv2RuleGroupSqliMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.SqliMatchStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.SqliMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.SqliMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementOne.ps1 index 3b7858660..885967c40 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementOne.ps1 @@ -1,66 +1,92 @@ function Add-VSWAFv2RuleGroupStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.StatementOne resource property to the template. + Adds an AWS::WAFv2::RuleGroup.StatementOne resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.StatementOne resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html .PARAMETER ByteMatchStatement + A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement + Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement + A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement + A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. +If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement + Statement used to identify web requests based on country of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER IPSetReferenceStatement + Statement that references a set of IP addresses to compare to incoming requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement + A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER RateBasedStatement + A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementOne .PARAMETER AndStatement + Logical AND statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-andstatement UpdateType: Mutable Type: AndStatementOne .PARAMETER OrStatement + Logical OR statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-orstatement UpdateType: Mutable Type: OrStatementOne .PARAMETER NotStatement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-notstatement UpdateType: Mutable Type: NotStatementOne diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementThree.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementThree.ps1 index d768023ba..c7de2f172 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementThree.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementThree.ps1 @@ -1,46 +1,62 @@ function Add-VSWAFv2RuleGroupStatementThree { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.StatementThree resource property to the template. + Adds an AWS::WAFv2::RuleGroup.StatementThree resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.StatementThree resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html .PARAMETER ByteMatchStatement + A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement + Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement + A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement + A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. +If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement + Statement used to identify web requests based on country of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER IPSetReferenceStatement + Statement that references a set of IP addresses to compare to incoming requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement + A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementTwo.ps1 index b3c9d107a..7512bd2e4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupStatementTwo.ps1 @@ -1,66 +1,92 @@ function Add-VSWAFv2RuleGroupStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.StatementTwo resource property to the template. + Adds an AWS::WAFv2::RuleGroup.StatementTwo resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.StatementTwo resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html .PARAMETER ByteMatchStatement + A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement + Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement + A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement + A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. +If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement + Statement used to identify web requests based on country of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER IPSetReferenceStatement + Statement that references a set of IP addresses to compare to incoming requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement + A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER RateBasedStatement + A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementTwo .PARAMETER AndStatement + Logical AND statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-andstatement UpdateType: Mutable Type: AndStatementTwo .PARAMETER OrStatement + Logical OR statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-orstatement UpdateType: Mutable Type: OrStatementTwo .PARAMETER NotStatement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-notstatement UpdateType: Mutable Type: NotStatementTwo diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 index 8d945bbc6..387767a76 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupTextTransformation.ps1 @@ -1,21 +1,59 @@ function Add-VSWAFv2RuleGroupTextTransformation { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.TextTransformation resource property to the template. + Adds an AWS::WAFv2::RuleGroup.TextTransformation resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.TextTransformation resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html .PARAMETER Priority + Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Type + You can specify the following transformation types: +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-type UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 index 87e38fd54..3201af716 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupVisibilityConfig.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2RuleGroupVisibilityConfig { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.VisibilityConfig resource property to the template. + Adds an AWS::WAFv2::RuleGroup.VisibilityConfig resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.VisibilityConfig resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Defines and enables Amazon CloudWatch metrics and web request sample collection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html .PARAMETER SampledRequestsEnabled + A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-sampledrequestsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER CloudWatchMetricsEnabled + A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-cloudwatchmetricsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER MetricName + A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-metricname UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 index 0c758beb5..3535a6eb8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2RuleGroupXssMatchStatement.ps1 @@ -1,21 +1,29 @@ function Add-VSWAFv2RuleGroupXssMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup.XssMatchStatement resource property to the template. + Adds an AWS::WAFv2::RuleGroup.XssMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.XssMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement that defines a cross-site scripting (XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 index 85e763d9d..ff13e9b7e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementOne.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2WebACLAndStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.AndStatementOne resource property to the template. + Adds an AWS::WAFv2::WebACL.AndStatementOne resource property to the template. Logical AND statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::WebACL.AndStatementOne resource property to the template. - +Logical AND statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementone.html .PARAMETER Statements + Logical AND statements used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementone.html#cfn-wafv2-webacl-andstatementone-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 index 3519ad457..aaffb7c40 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLAndStatementTwo.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2WebACLAndStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.AndStatementTwo resource property to the template. + Adds an AWS::WAFv2::WebACL.AndStatementTwo resource property to the template. Logical AND statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::WebACL.AndStatementTwo resource property to the template. - +Logical AND statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementtwo.html .PARAMETER Statements + Logical AND statements used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementtwo.html#cfn-wafv2-webacl-andstatementtwo-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 index b7499e8f3..de7b9f1a4 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLByteMatchStatement.ps1 @@ -1,37 +1,67 @@ function Add-VSWAFv2WebACLByteMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.ByteMatchStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.ByteMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.ByteMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html .PARAMETER SearchString + A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive. +Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you. +For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you provide the string BadBot in the value of SearchString. +You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-searchstring UpdateType: Mutable PrimitiveType: String .PARAMETER SearchStringBase64 + String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in SearchString instead. +You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-searchstringbase64 UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .PARAMETER PositionalConstraint + The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following: +**CONTAINS** +The specified part of the web request must include the value of SearchString, but the location doesn't matter. +**CONTAINS_WORD** +The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore A-Z, a-z, 0-9, or _. In addition, SearchString must be a word, which means that both of the following are true: ++ SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore _. Examples include the value of a header and ;BadBot. ++ SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore _, for example, BadBot; and -BadBot;. +**EXACTLY** +The value of the specified part of the web request must exactly match the value of SearchString. +**STARTS_WITH** +The value of SearchString must appear at the beginning of the specified part of the web request. +**ENDS_WITH** +The value of SearchString must appear at the end of the specified part of the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-positionalconstraint UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 index 0f16fb5ae..2778f58a1 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLDefaultAction.ps1 @@ -1,21 +1,29 @@ function Add-VSWAFv2WebACLDefaultAction { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.DefaultAction resource property to the template. + Adds an AWS::WAFv2::WebACL.DefaultAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.DefaultAction resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so count is not allowed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html .PARAMETER Allow + Specifies that AWS WAF should allow requests by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-allow UpdateType: Mutable PrimitiveType: Json .PARAMETER Block + Specifies that AWS WAF should block requests by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-block UpdateType: Mutable PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 index 9ad7a673c..9ad307d94 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLExcludedRule.ps1 @@ -1,16 +1,22 @@ function Add-VSWAFv2WebACLExcludedRule { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.ExcludedRule resource property to the template. + Adds an AWS::WAFv2::WebACL.ExcludedRule resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.ExcludedRule resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT. This effectively excludes the rule from acting on web requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html .PARAMETER Name + The name of the rule to exclude. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html#cfn-wafv2-webacl-excludedrule-name UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 index 1195a957c..0a1c1b642 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLFieldToMatch.ps1 @@ -1,46 +1,65 @@ function Add-VSWAFv2WebACLFieldToMatch { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.FieldToMatch resource property to the template. + Adds an AWS::WAFv2::WebACL.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.FieldToMatch resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html .PARAMETER SingleHeader + Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singleheader UpdateType: Mutable PrimitiveType: Json .PARAMETER SingleQueryArgument + Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singlequeryargument UpdateType: Mutable PrimitiveType: Json .PARAMETER AllQueryArguments + Inspect all query arguments. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-allqueryarguments UpdateType: Mutable PrimitiveType: Json .PARAMETER UriPath + Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-uripath UpdateType: Mutable PrimitiveType: Json .PARAMETER QueryString + Inspect the query string. This is the part of a URL that appears after a ? character, if any. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-querystring UpdateType: Mutable PrimitiveType: Json .PARAMETER Body + Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. +Note that only the first 8 KB 8192 bytes of the request body are forwarded to AWS WAF for inspection. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-body UpdateType: Mutable PrimitiveType: Json .PARAMETER Method + Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-method UpdateType: Mutable PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 index f4197c108..57a4fb452 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLGeoMatchStatement.ps1 @@ -1,16 +1,22 @@ function Add-VSWAFv2WebACLGeoMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.GeoMatchStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.GeoMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.GeoMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to identify web requests based on country of origin. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html .PARAMETER CountryCodes + An array of two-character country codes, for example, "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html#cfn-wafv2-webacl-geomatchstatement-countrycodes UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 index c264a6a2d..38ca6bb0f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLIPSetReferenceStatement.ps1 @@ -1,16 +1,24 @@ function Add-VSWAFv2WebACLIPSetReferenceStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.IPSetReferenceStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.IPSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.IPSetReferenceStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. + +Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html .PARAMETER Arn + The Amazon Resource Name ARN of the IPSet that this statement references. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html#cfn-wafv2-webacl-ipsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 index 62f7b6bfa..b8897b1c3 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLManagedRuleGroupStatement.ps1 @@ -1,26 +1,38 @@ function Add-VSWAFv2WebACLManagedRuleGroupStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.ManagedRuleGroupStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.ManagedRuleGroupStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.ManagedRuleGroupStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. + +You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html .PARAMETER Name + The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-name UpdateType: Mutable PrimitiveType: String .PARAMETER VendorName + The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-vendorname UpdateType: Mutable PrimitiveType: String .PARAMETER ExcludedRules + The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-excludedrules UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 index 2b6e6a081..6449c2ed0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementOne.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2WebACLNotStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.NotStatementOne resource property to the template. + Adds an AWS::WAFv2::WebACL.NotStatementOne resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.NotStatementOne resource property to the template. - +Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementone.html .PARAMETER Statement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementone.html#cfn-wafv2-webacl-notstatementone-statement UpdateType: Mutable Type: StatementTwo diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 index 5a9b01410..709d1268f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLNotStatementTwo.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2WebACLNotStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.NotStatementTwo resource property to the template. + Adds an AWS::WAFv2::WebACL.NotStatementTwo resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.NotStatementTwo resource property to the template. - +Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementtwo.html .PARAMETER Statement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementtwo.html#cfn-wafv2-webacl-notstatementtwo-statement UpdateType: Mutable Type: StatementThree diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 index b8ad4de57..e7bd7e056 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementOne.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2WebACLOrStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.OrStatementOne resource property to the template. + Adds an AWS::WAFv2::WebACL.OrStatementOne resource property to the template. Logical OR statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.OrStatementOne resource property to the template. - +Logical OR statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementone.html .PARAMETER Statements + Logical OR statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementone.html#cfn-wafv2-webacl-orstatementone-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 index 6651d8655..80843fe4f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOrStatementTwo.ps1 @@ -1,16 +1,18 @@ function Add-VSWAFv2WebACLOrStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.OrStatementTwo resource property to the template. + Adds an AWS::WAFv2::WebACL.OrStatementTwo resource property to the template. Logical OR statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::WebACL.OrStatementTwo resource property to the template. - +Logical OR statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementtwo.html .PARAMETER Statements + Logical OR statements used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementtwo.html#cfn-wafv2-webacl-orstatementtwo-statements UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 index 96b6cc58e..bc0501123 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLOverrideAction.ps1 @@ -1,21 +1,29 @@ function Add-VSWAFv2WebACLOverrideAction { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.OverrideAction resource property to the template. + Adds an AWS::WAFv2::WebACL.OverrideAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.OverrideAction resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count, in which case, if the rule matches a web request, it only counts the match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html .PARAMETER Count + Override the rule action setting to count. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-count UpdateType: Mutable PrimitiveType: Json .PARAMETER None + Don't override the rule action setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-none UpdateType: Mutable PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 index 1e08eec13..3ee53e11f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementOne.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2WebACLRateBasedStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.RateBasedStatementOne resource property to the template. + Adds an AWS::WAFv2::WebACL.RateBasedStatementOne resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. .DESCRIPTION Adds an AWS::WAFv2::WebACL.RateBasedStatementOne resource property to the template. +A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. + +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html .PARAMETER Limit + Limit on the web request that match any nested statement criteria in any 5 minute period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType + Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement + Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-scopedownstatement UpdateType: Mutable Type: StatementTwo diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 index af38865c9..a42fb91c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRateBasedStatementTwo.ps1 @@ -1,26 +1,32 @@ function Add-VSWAFv2WebACLRateBasedStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.RateBasedStatementTwo resource property to the template. + Adds an AWS::WAFv2::WebACL.RateBasedStatementTwo resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.RateBasedStatementTwo resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html .PARAMETER Limit + Limit on the web request that match any nested statement criteria in any 5 minute period. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType + Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement + Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-scopedownstatement UpdateType: Mutable Type: StatementThree diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 index a2b629a4f..1f35f9991 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRegexPatternSetReferenceStatement.ps1 @@ -1,26 +1,38 @@ function Add-VSWAFv2WebACLRegexPatternSetReferenceStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. + +Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html .PARAMETER Arn + The Amazon Resource Name ARN of the RegexPatternSet that this statement references. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 index a868c5d64..88d3aff40 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRule.ps1 @@ -1,41 +1,57 @@ function Add-VSWAFv2WebACLRule { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.Rule resource property to the template. + Adds an AWS::WAFv2::WebACL.Rule resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.Rule resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html .PARAMETER Name + A friendly name of the rule. You can't change the name of a Rule after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-name UpdateType: Mutable PrimitiveType: String .PARAMETER Priority + If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Statement + The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-statement UpdateType: Mutable Type: StatementOne .PARAMETER Action + The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-action UpdateType: Mutable Type: RuleAction .PARAMETER OverrideAction + The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-overrideaction UpdateType: Mutable Type: OverrideAction .PARAMETER VisibilityConfig + Defines and enables Amazon CloudWatch metrics and web request sample collection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-visibilityconfig UpdateType: Mutable Type: VisibilityConfig diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 index ab830d7c6..9dadf6cc9 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleAction.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2WebACLRuleAction { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.RuleAction resource property to the template. + Adds an AWS::WAFv2::WebACL.RuleAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.RuleAction resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html .PARAMETER Allow + Instructs AWS WAF to allow the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-allow UpdateType: Mutable PrimitiveType: Json .PARAMETER Block + Instructs AWS WAF to block the web request. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-block UpdateType: Mutable PrimitiveType: Json .PARAMETER Count + Instructs AWS WAF to count the web request and allow it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-count UpdateType: Mutable PrimitiveType: Json diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 index 7ecc57c42..1a191d4b6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLRuleGroupReferenceStatement.ps1 @@ -1,21 +1,31 @@ function Add-VSWAFv2WebACLRuleGroupReferenceStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.RuleGroupReferenceStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.RuleGroupReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.RuleGroupReferenceStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. + +You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html .PARAMETER Arn + The Amazon Resource Name ARN of the entity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER ExcludedRules + The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-excludedrules UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 index 5aa063509..406e758a0 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSizeConstraintStatement.ps1 @@ -1,31 +1,47 @@ function Add-VSWAFv2WebACLSizeConstraintStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.SizeConstraintStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.SizeConstraintStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.SizeConstraintStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (> or less than (<. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. + +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. + +If you choose URI for the value of Part of the request to filter on, the slash (/ in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER ComparisonOperator + The operator to use to compare the request part to the size setting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-comparisonoperator UpdateType: Mutable PrimitiveType: String .PARAMETER Size + The size, in byte, to compare to the request part, after any transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-size UpdateType: Mutable PrimitiveType: Integer .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 index 5be1e7ed2..88d57f3c5 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLSqliMatchStatement.ps1 @@ -1,21 +1,29 @@ function Add-VSWAFv2WebACLSqliMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.SqliMatchStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.SqliMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.SqliMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementOne.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementOne.ps1 index da2deec49..9c1591d84 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementOne.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementOne.ps1 @@ -1,76 +1,106 @@ function Add-VSWAFv2WebACLStatementOne { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.StatementOne resource property to the template. + Adds an AWS::WAFv2::WebACL.StatementOne resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.StatementOne resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html .PARAMETER ByteMatchStatement + A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement + Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement + A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement + A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. +If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement + Statement used to identify web requests based on country of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER RuleGroupReferenceStatement + A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You can't nest this type of statement within another. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-rulegroupreferencestatement UpdateType: Mutable Type: RuleGroupReferenceStatement .PARAMETER IPSetReferenceStatement + Statement that references a set of IP addresses to compare to incoming requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement + A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER ManagedRuleGroupStatement + Statement that references a managed rule group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-managedrulegroupstatement UpdateType: Mutable Type: ManagedRuleGroupStatement .PARAMETER RateBasedStatement + A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementOne .PARAMETER AndStatement + Logical AND statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-andstatement UpdateType: Mutable Type: AndStatementOne .PARAMETER OrStatement + Logical OR statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-orstatement UpdateType: Mutable Type: OrStatementOne .PARAMETER NotStatement + Logical NOT statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-notstatement UpdateType: Mutable Type: NotStatementOne diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementThree.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementThree.ps1 index c35776a1a..21f875df6 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementThree.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementThree.ps1 @@ -1,56 +1,76 @@ function Add-VSWAFv2WebACLStatementThree { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.StatementThree resource property to the template. + Adds an AWS::WAFv2::WebACL.StatementThree resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.StatementThree resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html .PARAMETER ByteMatchStatement + A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement + Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement + A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement + A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. +If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement + Statement used to identify web requests based on country of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER RuleGroupReferenceStatement + A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You can't nest this type of statement within another. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-rulegroupreferencestatement UpdateType: Mutable Type: RuleGroupReferenceStatement .PARAMETER IPSetReferenceStatement + Statement that references a set of IP addresses to compare to incoming requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement + A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER ManagedRuleGroupStatement + Statement that references a managed rule group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-managedrulegroupstatement UpdateType: Mutable Type: ManagedRuleGroupStatement diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementTwo.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementTwo.ps1 index b658d3d28..655393204 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementTwo.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLStatementTwo.ps1 @@ -1,76 +1,106 @@ function Add-VSWAFv2WebACLStatementTwo { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.StatementTwo resource property to the template. + Adds an AWS::WAFv2::WebACL.StatementTwo resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.StatementTwo resource property to the template. - +Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html .PARAMETER ByteMatchStatement + A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement + Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement + A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement + A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. +If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. +If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement + Statement used to identify web requests based on country of origin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER RuleGroupReferenceStatement + A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You can't nest this type of statement within another. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-rulegroupreferencestatement UpdateType: Mutable Type: RuleGroupReferenceStatement .PARAMETER IPSetReferenceStatement + Statement that references a set of IP addresses to compare to incoming requests. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement + A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER ManagedRuleGroupStatement + Statement that references a managed rule group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-managedrulegroupstatement UpdateType: Mutable Type: ManagedRuleGroupStatement .PARAMETER RateBasedStatement + A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. +When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. +You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementTwo .PARAMETER AndStatement + Logical AND statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-andstatement UpdateType: Mutable Type: AndStatementTwo .PARAMETER OrStatement + Logical OR statement used in statement nesting. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-orstatement UpdateType: Mutable Type: OrStatementTwo .PARAMETER NotStatement + Logical NOT statement used to negate the match results of a nested statement. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-notstatement UpdateType: Mutable Type: NotStatementTwo diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 index e8ab6b088..852721199 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLTextTransformation.ps1 @@ -1,21 +1,59 @@ function Add-VSWAFv2WebACLTextTransformation { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.TextTransformation resource property to the template. + Adds an AWS::WAFv2::WebACL.TextTransformation resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.TextTransformation resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html .PARAMETER Priority + Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html#cfn-wafv2-webacl-texttransformation-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Type + You can specify the following transformation types: +**CMD_LINE** +When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: ++ Delete the following characters: " ' ^ ++ Delete spaces before the following characters: / ++ Replace the following characters with a space: , ; ++ Replace multiple spaces with one space ++ Convert uppercase letters A-Z to lowercase a-z +**COMPRESS_WHITE_SPACE** +Use this option to replace the following characters with a space character decimal 32: ++ f, formfeed, decimal 12 ++ t, tab, decimal 9 ++ n, newline, decimal 10 ++ r, carriage return, decimal 13 ++ v, vertical tab, decimal 11 ++ non-breaking space, decimal 160 +COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. +**HTML_ENTITY_DECODE** +Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: ++ Replaces ampersandquot; with " ++ Replaces ampersandnbsp; with a non-breaking space, decimal 160 ++ Replaces ampersandlt; with a "less than" symbol ++ Replaces ampersandgt; with > ++ Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters ++ Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters +**LOWERCASE** +Use this option to convert uppercase letters A-Z to lowercase a-z. +**URL_DECODE** +Use this option to decode a URL-encoded value. +**NONE** +Specify NONE if you don't want any text transformations. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html#cfn-wafv2-webacl-texttransformation-type UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 index 468614623..4e22214c8 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLVisibilityConfig.ps1 @@ -1,26 +1,36 @@ function Add-VSWAFv2WebACLVisibilityConfig { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.VisibilityConfig resource property to the template. + Adds an AWS::WAFv2::WebACL.VisibilityConfig resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.VisibilityConfig resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Defines and enables Amazon CloudWatch metrics and web request sample collection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html .PARAMETER SampledRequestsEnabled + A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-sampledrequestsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER CloudWatchMetricsEnabled + A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-cloudwatchmetricsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER MetricName + A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-metricname UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 index 80c5d519a..756f7264e 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWAFv2WebACLXssMatchStatement.ps1 @@ -1,21 +1,29 @@ function Add-VSWAFv2WebACLXssMatchStatement { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL.XssMatchStatement resource property to the template. + Adds an AWS::WAFv2::WebACL.XssMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.XssMatchStatement resource property to the template. +**Note** +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +A rule statement that defines a cross-site scripting (XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html .PARAMETER FieldToMatch + The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations + Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-texttransformations UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 b/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 index ed07099bf..c0ccc6c3f 100644 --- a/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 +++ b/VaporShell/Public/Resource Property Types/Add-VSWorkSpacesWorkspaceWorkspaceProperties.ps1 @@ -32,7 +32,7 @@ Information about a WorkSpace. UpdateType: Mutable .PARAMETER RunningModeAutoStopTimeoutInMinutes - The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals. + The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 b/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 index 6bc9f3c19..2dbeb2c75 100644 --- a/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 @@ -1,10 +1,10 @@ function New-VSACMPCACertificate { <# .SYNOPSIS - Adds an AWS::ACMPCA::Certificate resource to the template. + Adds an AWS::ACMPCA::Certificate resource to the template. The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority. For more information, see the IssueCertificate: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html action. .DESCRIPTION - Adds an AWS::ACMPCA::Certificate resource to the template. + Adds an AWS::ACMPCA::Certificate resource to the template. The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority. For more information, see the IssueCertificate: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html action. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html @@ -13,26 +13,37 @@ function New-VSACMPCACertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CertificateAuthorityArn + The Amazon Resource Name ARN for the private CA used to issue the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificateauthorityarn UpdateType: Immutable PrimitiveType: String .PARAMETER CertificateSigningRequest + The certificate signing request CSR for the certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificatesigningrequest UpdateType: Immutable PrimitiveType: String .PARAMETER SigningAlgorithm + The name of the algorithm that will be used to sign the certificate to be issued. +This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR . + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-signingalgorithm UpdateType: Immutable PrimitiveType: String .PARAMETER TemplateArn + Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For more information about ACM Private CA templates, see Using Templates: https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-templatearn UpdateType: Immutable PrimitiveType: String .PARAMETER Validity + The period of time during which the certificate will be valid. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validity UpdateType: Immutable Type: Validity diff --git a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 index 9f44dce1f..ee5915045 100644 --- a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 +++ b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 @@ -1,10 +1,14 @@ function New-VSACMPCACertificateAuthority { <# .SYNOPSIS - Adds an AWS::ACMPCA::CertificateAuthority resource to the template. + Adds an AWS::ACMPCA::CertificateAuthority resource to the template. Use the AWS::ACMPCA::CertificateAuthority resource to create a private CA. Once the CA exists, you can use the AWS::ACMPCA::Certificate resource to issue a new CA certificate. Alternatively, you can issue a CA certificate using an on-premises CA, and then use the AWS::ACMPCA::CertificateAuthorityActivation resource to import the new CA certificate and activate the CA. .DESCRIPTION - Adds an AWS::ACMPCA::CertificateAuthority resource to the template. + Adds an AWS::ACMPCA::CertificateAuthority resource to the template. Use the AWS::ACMPCA::CertificateAuthority resource to create a private CA. Once the CA exists, you can use the AWS::ACMPCA::Certificate resource to issue a new CA certificate. Alternatively, you can issue a CA certificate using an on-premises CA, and then use the AWS::ACMPCA::CertificateAuthorityActivation resource to import the new CA certificate and activate the CA. + +**Note** + +Before removing a AWS::ACMPCA::CertificateAuthority resource from the CloudFormation stack, disable the affected CA. Otherwise, the action will fail. You can disable the CA by removing its associated AWS::ACMPCA::CertificateAuthorityActivation resource from CloudFormation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html @@ -13,31 +17,44 @@ function New-VSACMPCACertificateAuthority { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + Type of your private CA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-type UpdateType: Immutable PrimitiveType: String .PARAMETER KeyAlgorithm + Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keyalgorithm UpdateType: Immutable PrimitiveType: String .PARAMETER SigningAlgorithm + Name of the algorithm your private CA uses to sign certificate requests. +This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-signingalgorithm UpdateType: Immutable PrimitiveType: String .PARAMETER Subject + Structure that contains X.500 distinguished name information for your private CA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-subject UpdateType: Immutable Type: Subject .PARAMETER RevocationConfiguration + Information about the certificate revocation list CRL created and maintained by your private CA. Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your certificate authority can create and maintain a certificate revocation list CRL. A CRL contains information about certificates that have been revoked. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-revocationconfiguration UpdateType: Mutable Type: RevocationConfiguration .PARAMETER Tags + Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-tags UpdateType: Mutable Type: List @@ -125,16 +142,8 @@ function New-VSACMPCACertificateAuthority { $Subject, [parameter(Mandatory = $false)] $RevocationConfiguration, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 index ff700e0c2..3f42d8d4e 100644 --- a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 @@ -1,10 +1,10 @@ function New-VSACMPCACertificateAuthorityActivation { <# .SYNOPSIS - Adds an AWS::ACMPCA::CertificateAuthorityActivation resource to the template. + Adds an AWS::ACMPCA::CertificateAuthorityActivation resource to the template. The AWS::ACMPCA::CertificateAuthorityActivation resource creates and installs a CA certificate on a CA. If no status is specified, the AWS::ACMPCA::CertificateAuthorityActivation resource status defaults to ACTIVE. Once the CA has a CA certificate installed, you can use the resource to toggle the CA status field between ACTIVE and DISABLED. .DESCRIPTION - Adds an AWS::ACMPCA::CertificateAuthorityActivation resource to the template. + Adds an AWS::ACMPCA::CertificateAuthorityActivation resource to the template. The AWS::ACMPCA::CertificateAuthorityActivation resource creates and installs a CA certificate on a CA. If no status is specified, the AWS::ACMPCA::CertificateAuthorityActivation resource status defaults to ACTIVE. Once the CA has a CA certificate installed, you can use the resource to toggle the CA status field between ACTIVE and DISABLED. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html @@ -13,21 +13,29 @@ function New-VSACMPCACertificateAuthorityActivation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CertificateAuthorityArn + The Amazon Resource Name ARN of your private CA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificateauthorityarn UpdateType: Immutable PrimitiveType: String .PARAMETER Certificate + The Base64 PEM-encoded certificate authority certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificate UpdateType: Mutable PrimitiveType: String .PARAMETER CertificateChain + The Base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificatechain UpdateType: Mutable PrimitiveType: String .PARAMETER Status + Status of your private CA. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-status UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 b/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 index a442af317..1670d858c 100644 --- a/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 @@ -1,10 +1,10 @@ function New-VSAccessAnalyzerAnalyzer { <# .SYNOPSIS - Adds an AWS::AccessAnalyzer::Analyzer resource to the template. + Adds an AWS::AccessAnalyzer::Analyzer resource to the template. The AWS::AccessAnalyzer::Analyzer resource specifies a new analyzer. The analyzer is an object that represents the IAM Access Analyzer feature. An analyzer is required for Access Analyzer to become operational. .DESCRIPTION - Adds an AWS::AccessAnalyzer::Analyzer resource to the template. + Adds an AWS::AccessAnalyzer::Analyzer resource to the template. The AWS::AccessAnalyzer::Analyzer resource specifies a new analyzer. The analyzer is an object that represents the IAM Access Analyzer feature. An analyzer is required for Access Analyzer to become operational. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html @@ -13,17 +13,23 @@ function New-VSAccessAnalyzerAnalyzer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AnalyzerName + The name of the analyzer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzername UpdateType: Immutable PrimitiveType: String .PARAMETER ArchiveRules + Specifies the archive rules to add for the analyzer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-archiverules UpdateType: Mutable Type: List ItemType: ArchiveRule .PARAMETER Tags + The tags to apply to the analyzer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-tags UpdateType: Mutable Type: List @@ -31,6 +37,8 @@ function New-VSAccessAnalyzerAnalyzer { DuplicatesAllowed: False .PARAMETER Type + The type represents the zone of trust for the analyzer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-type UpdateType: Immutable PrimitiveType: String @@ -102,16 +110,8 @@ function New-VSAccessAnalyzerAnalyzer { } })] $ArchiveRules, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 b/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 index 2dded82e7..50a1871d2 100644 --- a/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAlexaASKSkill.ps1 @@ -96,6 +96,9 @@ function New-VSAlexaASKSkill { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 index 3c55b8554..b5e48d51e 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 @@ -51,12 +51,14 @@ This permission is required to attach the ENI to the broker instance. UpdateType: Mutable .PARAMETER StorageType + The broker's storage type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-storagetype PrimitiveType: String UpdateType: Immutable .PARAMETER EngineVersion - The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html. + The version of the broker engine. For a list of supported engine versions, see Engine: https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html in the *Amazon MQ Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 index 68a94335e..daff5d610 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 @@ -225,16 +225,8 @@ function New-VSAmplifyApp { $CustomRules, [parameter(Mandatory = $false)] $BasicAuthConfig, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 index 069e44e70..dc1c76ec1 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 @@ -35,14 +35,19 @@ function New-VSAmplifyBranch { UpdateType: Immutable .PARAMETER PullRequestEnvironmentName - Name for a branch, part of an Amplify App. + If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named prod, test, or dev that you initialized with the Amplify CLI and mapped to this branch. +To enable pull request previews, set the EnablePullRequestPreview property to true. +If you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console deletes this environment when the pull request is closed. +For more information about creating backend environments, see Feature Branch Deployments and Team Workflows: https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html in the *AWS Amplify Console User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname PrimitiveType: String UpdateType: Mutable .PARAMETER EnablePullRequestPreview - Name for a branch, part of an Amplify App. + Sets whether the Amplify Console creates a preview for each pull request that is made for this branch. If this property is enabled, the Amplify Console deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. +To provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the PullRequestEnvironmentName property. +For more information, see Web Previews: https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html in the *AWS Amplify Console User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview PrimitiveType: Boolean @@ -237,16 +242,8 @@ function New-VSAmplifyBranch { $BranchName, [parameter(Mandatory = $false)] $BasicAuthConfig, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 index 2e0318541..1976f8ca6 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 @@ -34,7 +34,7 @@ function New-VSApiGatewayApiKey { UpdateType: Mutable .PARAMETER GenerateDistinctId - Specifies whether the key identifier is distinct from the created API key value. + Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid PrimitiveType: Boolean @@ -58,7 +58,7 @@ If you specify a name, you cannot perform updates that require replacement of th UpdateType: Mutable .PARAMETER Tags - + apikey:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/apikey-create/ in the *Amazon API Gateway REST API Reference* + An array of arbitrary tags key-value pairs to associate with the API key. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags DuplicatesAllowed: True @@ -67,7 +67,7 @@ If you specify a name, you cannot perform updates that require replacement of th UpdateType: Mutable .PARAMETER Value - The value of the API key. + The value of the API key. Must be at least 20 characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value PrimitiveType: String @@ -184,16 +184,8 @@ If you specify a name, you cannot perform updates that require replacement of th } })] $StageKeys, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 index 60db2a8ac..890134b5a 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 @@ -20,7 +20,7 @@ function New-VSApiGatewayClientCertificate { UpdateType: Mutable .PARAMETER Tags - + clientcertificate:generate: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/clientcertificate-generate/ in the *Amazon API Gateway REST API Reference* + An array of arbitrary tags key-value pairs to associate with the client certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags DuplicatesAllowed: True @@ -84,16 +84,8 @@ function New-VSApiGatewayClientCertificate { } })] $Description, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 index 7d3662b51..591ad0f0f 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 @@ -43,14 +43,15 @@ You can use a custom domain name to provide a URL that's more intuitive and easi UpdateType: Mutable .PARAMETER SecurityPolicy - + domainname:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/domainname-create/ in the *Amazon API Gateway REST API Reference* + The Transport Layer Security TLS version + cipher suite for this domain name. +Valid values include TLS_1_0 and TLS_1_2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy PrimitiveType: String UpdateType: Mutable .PARAMETER Tags - + domainname:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/domainname-create/ in the *Amazon API Gateway REST API Reference* + An array of arbitrary tags key-value pairs to associate with the domain name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags DuplicatesAllowed: True @@ -149,16 +150,8 @@ You can use a custom domain name to provide a URL that's more intuitive and easi } })] $SecurityPolicy, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 index 8f294ee58..d1de0a537 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 @@ -29,7 +29,7 @@ function New-VSApiGatewayMethod { UpdateType: Mutable .PARAMETER AuthorizationType - The method's authorization type. For valid values, see Method: https://docs.aws.amazon.com/apigateway/api-reference/resource/method/ in the *API Gateway API Reference*. + The method's authorization type. This parameter is required. For valid values, see Method: https://docs.aws.amazon.com/apigateway/api-reference/resource/method/ in the *API Gateway API Reference*. If you specify the AuthorizerId property, specify CUSTOM for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype @@ -74,7 +74,7 @@ If you specify the AuthorizerId property, specify CUSTOM for this property. UpdateType: Mutable .PARAMETER RequestModels - The resources that are used for the response's content type. Specify response models as key-value pairs string-to-string mapping, with a content type as the key and a Model resource name as the value. + The resources that are used for the request's content type. Specify request models as key-value pairs string-to-string mapping, with a content type as the key and a Model resource name as the value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 index 56b793646..539958fee 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 @@ -26,7 +26,7 @@ On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiat UpdateType: Mutable .PARAMETER BinaryMediaTypes - The list of binary media types that are supported by the RestApi resource, such as image/png or application/octet-stream. By default, RestApi supports only UTF-8-encoded text payloads. For more information, see Enable Support for Binary Payloads in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html in the *API Gateway Developer Guide*. Duplicates are not allowed. + The list of binary media types that are supported by the RestApi resource, such as image/png or application/octet-stream. By default, RestApi supports only UTF-8-encoded text payloads. Duplicates are not allowed. Slashes must be escaped with ~1. For example, image/png would be image~1png in the BinaryMediaTypes list. For more information, see Enable Support for Binary Payloads in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html in the *API Gateway Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes DuplicatesAllowed: False @@ -100,14 +100,14 @@ On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiat UpdateType: Mutable .PARAMETER Policy - A policy document that contains the permissions for the RestApi resource, in JSON format. + A policy document that contains the permissions for the RestApi resource, in JSON format. To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*". Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags - + restapi:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/restapi-create/ in the *Amazon API Gateway REST API Reference* + An array of arbitrary tags key-value pairs to associate with the API. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags DuplicatesAllowed: True @@ -257,16 +257,8 @@ On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiat } })] $Policy, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 index 015efa623..cade16654 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 @@ -48,7 +48,7 @@ function New-VSApiGatewayStage { UpdateType: Mutable .PARAMETER DeploymentId - The ID of the deployment that the stage is associated with. + The ID of the deployment that the stage is associated with. This parameter is required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid PrimitiveType: String @@ -265,16 +265,8 @@ For more information, see Trace API Gateway API Execution with AWS X-Ray: https: } })] $StageName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 index 14e55f875..0b7c0ac6e 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 @@ -36,7 +36,7 @@ function New-VSApiGatewayUsagePlan { UpdateType: Mutable .PARAMETER Tags - + usageplan:create: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/usageplan-create/ in the *Amazon API Gateway REST API Reference* + An array of arbitrary tags key-value pairs to associate with the usage plan. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags DuplicatesAllowed: True @@ -127,16 +127,8 @@ function New-VSApiGatewayUsagePlan { $Description, [parameter(Mandatory = $false)] $Quota, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $Throttle, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 index 7ce1f4482..ef5bd3845 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Api { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Api resource to the template. The AWS::ApiGatewayV2::Api resource creates an API. Currently only WebSocket APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Api resource to the template. The AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs (beta are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html in the *API Gateway Developer Guide*. For more information about HTTP APIs, see HTTP APIs: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html in the *API Gateway Developer Guide.* .DESCRIPTION - Adds an AWS::ApiGatewayV2::Api resource to the template. The AWS::ApiGatewayV2::Api resource creates an API. Currently only WebSocket APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Api resource to the template. The AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs (beta are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html in the *API Gateway Developer Guide*. For more information about HTTP APIs, see HTTP APIs: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html in the *API Gateway Developer Guide.* .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html @@ -13,14 +13,14 @@ function New-VSApiGatewayV2Api { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RouteSelectionExpression - The route selection expression for the API. + The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER BodyS3Location - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. Type: BodyS3Location Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location @@ -34,49 +34,49 @@ function New-VSApiGatewayV2Api { UpdateType: Mutable .PARAMETER BasePath - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html. Supported only for HTTP APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath PrimitiveType: String UpdateType: Mutable .PARAMETER FailOnWarnings - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + Specifies whether to rollback the API creation true or not false when a warning is encountered. The default value is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DisableSchemaValidation - Avoid validating models when creating a deployment. + Avoid validating models when creating a deployment. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Name - The name of the API. + The name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name PrimitiveType: String UpdateType: Mutable .PARAMETER Target - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target PrimitiveType: String UpdateType: Mutable .PARAMETER CredentialsArn - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name ARN. To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn PrimitiveType: String UpdateType: Mutable .PARAMETER CorsConfiguration - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + A CORS configuration. Supported only for HTTP APIs. See Configuring CORS: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html for more information. Type: Cors Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration @@ -90,35 +90,35 @@ function New-VSApiGatewayV2Api { UpdateType: Mutable .PARAMETER ProtocolType - The API protocol: Currently only WEBSOCKET is supported. + The API protocol. Required unless you specify an OpenAPI definition for Body or S3BodyLocation. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype PrimitiveType: String UpdateType: Immutable .PARAMETER RouteKey - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey PrimitiveType: String UpdateType: Mutable .PARAMETER Body - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags - + CreateApi: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi in the *Amazon API Gateway Version 2 API Reference* + The collection of tags. Each tag element is associated with a given resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER ApiKeySelectionExpression - An API key selection expression. See API Key Selection Expressions: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions. + An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 index e99269f3a..8de01efca 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2ApiMapping { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. For more information, see CreateApiMapping: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping in the *Amazon API Gateway V2 API Reference*. + Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping in the *Amazon API Gateway V2 API Reference*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. For more information, see CreateApiMapping: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping in the *Amazon API Gateway V2 API Reference*. + Adds an AWS::ApiGatewayV2::ApiMapping resource to the template. The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping in the *Amazon API Gateway V2 API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 index e0d2a5ab4..bafd06942 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Authorizer { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Authorizer resource to the template. The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Authorizer resource to the template. The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function for a WebSocket API or a JSON Web Token (JWT authorizer for an HTTP API. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html in the *API Gateway Developer Guide*. For more information about JWT authorizers for HTTP APIs, see JWT authorizers: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Authorizer resource to the template. The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Authorizer resource to the template. The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function for a WebSocket API or a JSON Web Token (JWT authorizer for an HTTP API. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html in the *API Gateway Developer Guide*. For more information about JWT authorizers for HTTP APIs, see JWT authorizers: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html @@ -13,7 +13,7 @@ function New-VSApiGatewayV2Authorizer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER IdentityValidationExpression - The validation expression does not apply to the REQUEST authorizer. + This parameter is not used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression PrimitiveType: String @@ -27,28 +27,28 @@ function New-VSApiGatewayV2Authorizer { UpdateType: Mutable .PARAMETER AuthorizerCredentialsArn - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name ARN. To use resource-based permissions on the Lambda function, specify null. + Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name ARN. To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerType - The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters. + The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype PrimitiveType: String UpdateType: Mutable .PARAMETER JwtConfiguration - + CreateAuthorizer: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers.html#CreateAuthorizer in the *Amazon API Gateway Version 2 API Reference* + The JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Type: JWTConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration UpdateType: Mutable .PARAMETER AuthorizerResultTtlInSeconds - The time to live TTL, in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. + Authorizer caching is not currently supported. Don't specify this value for authorizers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds PrimitiveType: Integer @@ -56,7 +56,8 @@ function New-VSApiGatewayV2Authorizer { .PARAMETER IdentitySource The identity source for which authorization is requested. -For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. +For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. +For JWT, a single entry that specifies where to extract the JSON Web Token JWT from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization". PrimitiveItemType: String Type: List diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 index bbc251770..c0598fce5 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Deployment { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Deployment resource to the template. The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Deployment resource to the template. The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Deployment resource to the template. The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Deployment resource to the template. The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 index c292e955d..1ab4ee6aa 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 @@ -30,7 +30,7 @@ You can use a custom domain name to provide a URL that's more intuitive and easi UpdateType: Mutable .PARAMETER Tags - + CreateDomainName: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames.html#CreateDomainName in the *Amazon API Gateway Version 2 API Reference* + The collection of tags associated with a domain name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 index 872c72240..d39c3feb1 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Integration { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Integration resource to the template. The AWS::ApiGatewayV2::Integration resource creates an integration for an API. For more information, see Set up a WebSocket API Integration Request in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Integration resource to the template. The AWS::ApiGatewayV2::Integration resource creates an integration for an API. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Integration resource to the template. The AWS::ApiGatewayV2::Integration resource creates an integration for an API. For more information, see Set up a WebSocket API Integration Request in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Integration resource to the template. The AWS::ApiGatewayV2::Integration resource creates an integration for an API. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html @@ -20,7 +20,7 @@ function New-VSApiGatewayV2Integration { UpdateType: Mutable .PARAMETER TemplateSelectionExpression - The template selection expression for the integration. + The template selection expression for the integration. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression PrimitiveType: String @@ -41,7 +41,7 @@ function New-VSApiGatewayV2Integration { UpdateType: Mutable .PARAMETER PassthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. + Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response. @@ -51,7 +51,7 @@ WHEN_NO_TEMPLATES allows pass-through when the integration has no content types UpdateType: Mutable .PARAMETER RequestParameters - A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. + A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters PrimitiveType: Json @@ -65,7 +65,7 @@ WHEN_NO_TEMPLATES allows pass-through when the integration has no content types UpdateType: Mutable .PARAMETER PayloadFormatVersion - + CreateIntegration: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations.html#CreateIntegration in the *Amazon API Gateway Version 2 API Reference* + Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion PrimitiveType: String @@ -79,21 +79,21 @@ WHEN_NO_TEMPLATES allows pass-through when the integration has no content types UpdateType: Mutable .PARAMETER RequestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template as a String is the value. + Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template as a String is the value. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates PrimitiveType: Json UpdateType: Mutable .PARAMETER TimeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. + Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis PrimitiveType: Integer UpdateType: Mutable .PARAMETER ContentHandlingStrategy - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. @@ -111,11 +111,11 @@ If this property is not defined, the response payload will be passed through fro .PARAMETER IntegrationType The integration type of an integration. One of the following: -AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. +AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. -HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration. +HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. -MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. +MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 index 2f0c9cc32..479ef6a8c 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2IntegrationResponse { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an API. For more information, see Set up WebSocket API Integration Responses in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API. For more information, see Set up WebSocket API Integration Responses in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html in the *API Gateway Developer Guide*. .DESCRIPTION - Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an API. For more information, see Set up WebSocket API Integration Responses in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::IntegrationResponse resource to the template. The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API. For more information, see Set up WebSocket API Integration Responses in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html in the *API Gateway Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html @@ -20,7 +20,7 @@ function New-VSApiGatewayV2IntegrationResponse { UpdateType: Mutable .PARAMETER TemplateSelectionExpression - The template selection expression for the integration response. + The template selection expression for the integration response. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression PrimitiveType: String @@ -34,7 +34,7 @@ function New-VSApiGatewayV2IntegrationResponse { UpdateType: Mutable .PARAMETER ContentHandlingStrategy - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 index 20f383c12..320ad5982 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Route { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Route resource to the template. The AWS::ApiGatewayV2::Route resource creates a route for a WebSocket API. For more information, see Set up Routes for a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Route resource to the template. The AWS::ApiGatewayV2::Route resource creates a route for an API. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Route resource to the template. The AWS::ApiGatewayV2::Route resource creates a route for a WebSocket API. For more information, see Set up Routes for a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Route resource to the template. The AWS::ApiGatewayV2::Route resource creates a route for an API. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html @@ -20,21 +20,21 @@ function New-VSApiGatewayV2Route { UpdateType: Mutable .PARAMETER RouteResponseSelectionExpression - The route response selection expression for the route. + The route response selection expression for the route. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression PrimitiveType: String UpdateType: Mutable .PARAMETER AuthorizerId - The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer. + The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid PrimitiveType: String UpdateType: Mutable .PARAMETER RequestModels - The request models for the route. + The request models for the route. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels PrimitiveType: Json @@ -56,7 +56,7 @@ function New-VSApiGatewayV2Route { UpdateType: Mutable .PARAMETER ApiKeyRequired - Specifies whether an API key is required for the route. + Specifies whether an API key is required for the route. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired PrimitiveType: Boolean @@ -70,14 +70,14 @@ function New-VSApiGatewayV2Route { UpdateType: Mutable .PARAMETER AuthorizationType - The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. + The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype PrimitiveType: String UpdateType: Mutable .PARAMETER ModelSelectionExpression - The model selection expression for the route. + The model selection expression for the route. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression PrimitiveType: String @@ -91,7 +91,7 @@ function New-VSApiGatewayV2Route { UpdateType: Immutable .PARAMETER RequestParameters - The request parameters for the route. + The request parameters for the route. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 index 21b6ab2be..615c95211 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 @@ -34,7 +34,7 @@ function New-VSApiGatewayV2RouteResponse { UpdateType: Immutable .PARAMETER ModelSelectionExpression - The model selection expression for the route response. + The model selection expression for the route response. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 index ef714a16a..9e35f9d73 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 @@ -1,10 +1,10 @@ function New-VSApiGatewayV2Stage { <# .SYNOPSIS - Adds an AWS::ApiGatewayV2::Stage resource to the template. The AWS::ApiGatewayV2::Stage resource updates a stage for a WebSocket API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Stage resource to the template. The AWS::ApiGatewayV2::Stage resource updates a stage for an API. .DESCRIPTION - Adds an AWS::ApiGatewayV2::Stage resource to the template. The AWS::ApiGatewayV2::Stage resource updates a stage for a WebSocket API. For more information, see Deploy a WebSocket API in API Gateway: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html in the *API Gateway Developer Guide*. + Adds an AWS::ApiGatewayV2::Stage resource to the template. The AWS::ApiGatewayV2::Stage resource updates a stage for an API. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html @@ -13,14 +13,14 @@ function New-VSApiGatewayV2Stage { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ClientCertificateId - The identifier of a client certificate for a Stage. + The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid PrimitiveType: String UpdateType: Mutable .PARAMETER DeploymentId - The deployment identifier for the API stage. + The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid PrimitiveType: String @@ -41,7 +41,7 @@ function New-VSApiGatewayV2Stage { UpdateType: Mutable .PARAMETER AutoDeploy - + CreateStage: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages.html#CreateStage in the *Amazon API Gateway Version 2 API Reference* + Specifies whether updates to an API automatically trigger a new deployment. The default value is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy PrimitiveType: Boolean @@ -62,7 +62,7 @@ function New-VSApiGatewayV2Stage { UpdateType: Immutable .PARAMETER StageVariables - A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match A-Za-z0-9-._~:/?#&=,]+. + A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables PrimitiveType: Json @@ -83,7 +83,7 @@ function New-VSApiGatewayV2Stage { UpdateType: Mutable .PARAMETER Tags - + CreateStage: https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages.html#CreateStage in the *Amazon API Gateway Version 2 API Reference* + The collection of tags. Each tag element is associated with a given resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 index c4e04c3c5..74c960ad7 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 @@ -1,10 +1,24 @@ function New-VSAppConfigApplication { <# .SYNOPSIS - Adds an AWS::AppConfig::Application resource to the template. + Adds an AWS::AppConfig::Application resource to the template. The AWS::AppConfig::Application resource creates an application, which is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others. .DESCRIPTION - Adds an AWS::AppConfig::Application resource to the template. + Adds an AWS::AppConfig::Application resource to the template. The AWS::AppConfig::Application resource creates an application, which is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others. + +AppConfig requires that you create resources and deploy a configuration in the following order: + +1. Create an application + +1. Create an environment + +1. Create a configuration profile + +1. Create a deployment strategy + +1. Deploy the configuration + +For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html in the *AWS Systems Manager User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html @@ -13,17 +27,23 @@ function New-VSAppConfigApplication { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#cfn-appconfig-application-description PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#cfn-appconfig-application-tags ItemType: Tags UpdateType: Mutable .PARAMETER Name + A name for the application. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#cfn-appconfig-application-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 index e25c84dd0..26c64ec20 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 @@ -1,10 +1,30 @@ function New-VSAppConfigConfigurationProfile { <# .SYNOPSIS - Adds an AWS::AppConfig::ConfigurationProfile resource to the template. + Adds an AWS::AppConfig::ConfigurationProfile resource to the template. The AWS::AppConfig::ConfigurationProfile resource creates a configuration profile that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM documents and SSM Parameter Store parameters. A configuration profile includes the following information. .DESCRIPTION - Adds an AWS::AppConfig::ConfigurationProfile resource to the template. + Adds an AWS::AppConfig::ConfigurationProfile resource to the template. The AWS::AppConfig::ConfigurationProfile resource creates a configuration profile that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM documents and SSM Parameter Store parameters. A configuration profile includes the following information. + ++ The Uri location of the configuration data. + ++ The AWS Identity and Access Management (IAM role that provides access to the configuration data. + ++ A validator for the configuration data. Available validators include either a JSON Schema or the Amazon Resource Name (ARN of an AWS Lambda function. + +AppConfig requires that you create resources and deploy a configuration in the following order: + +1. Create an application + +1. Create an environment + +1. Create a configuration profile + +1. Create a deployment strategy + +1. Deploy the configuration + +For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html in the *AWS Systems Manager User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html @@ -13,38 +33,52 @@ function New-VSAppConfigConfigurationProfile { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LocationUri + A URI to locate the configuration. You can specify either a Systems Manager SSM document or an SSM Parameter Store parameter. For an SSM document, specify either the document name in the format ssm-document:// or the Amazon Resource Name ARN. For a parameter, specify either the parameter name in the format ssm-parameter:// or the ARN. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-locationuri PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A description of the configuration profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-description PrimitiveType: String UpdateType: Mutable .PARAMETER Validators + A list of methods for validating the configuration. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-validators ItemType: Validators UpdateType: Mutable .PARAMETER RetrievalRoleArn + The ARN of an IAM role with permission to access the configuration at the specified LocationUri. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-retrievalrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId + The application ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-tags ItemType: Tags UpdateType: Mutable .PARAMETER Name + A name for the configuration profile. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 index d50cc1de6..54ffbbbb4 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 @@ -1,10 +1,26 @@ function New-VSAppConfigDeployment { <# .SYNOPSIS - Adds an AWS::AppConfig::Deployment resource to the template. + Adds an AWS::AppConfig::Deployment resource to the template. The AWS::AppConfig::Deployment resource starts a deployment. Starting a deployment in AWS AppConfig calls the StartDeployment API action. This call includes the IDs of the AppConfig application, the environment, the configuration profile, and (optionally the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed. .DESCRIPTION - Adds an AWS::AppConfig::Deployment resource to the template. + Adds an AWS::AppConfig::Deployment resource to the template. The AWS::AppConfig::Deployment resource starts a deployment. Starting a deployment in AWS AppConfig calls the StartDeployment API action. This call includes the IDs of the AppConfig application, the environment, the configuration profile, and (optionally the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed. + +AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AppConfig rolls back the configuration. + +AppConfig requires that you create resources and deploy a configuration in the following order: + +1. Create an application + +1. Create an environment + +1. Create a configuration profile + +1. Create a deployment strategy + +1. Deploy the configuration + +For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html in the *AWS Systems Manager User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html @@ -13,36 +29,50 @@ function New-VSAppConfigDeployment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeploymentStrategyId + The deployment strategy ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-deploymentstrategyid PrimitiveType: String UpdateType: Immutable .PARAMETER ConfigurationProfileId + The configuration profile ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationprofileid PrimitiveType: String UpdateType: Immutable .PARAMETER EnvironmentId + The environment ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-environmentid PrimitiveType: String UpdateType: Immutable .PARAMETER Description + A description of the deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-description PrimitiveType: String UpdateType: Immutable .PARAMETER ConfigurationVersion + The configuration version to deploy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationversion PrimitiveType: String UpdateType: Immutable .PARAMETER ApplicationId + The application ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-tags ItemType: Tags diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 index 6275b1cc2..934c22ea1 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 @@ -1,10 +1,24 @@ function New-VSAppConfigDeploymentStrategy { <# .SYNOPSIS - Adds an AWS::AppConfig::DeploymentStrategy resource to the template. + Adds an AWS::AppConfig::DeploymentStrategy resource to the template. The AWS::AppConfig::DeploymentStrategy resource creates an AppConfig deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time. .DESCRIPTION - Adds an AWS::AppConfig::DeploymentStrategy resource to the template. + Adds an AWS::AppConfig::DeploymentStrategy resource to the template. The AWS::AppConfig::DeploymentStrategy resource creates an AppConfig deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time. + +AppConfig requires that you create resources and deploy a configuration in the following order: + +1. Create an application + +1. Create an environment + +1. Create a configuration profile + +1. Create a deployment strategy + +1. Deploy the configuration + +For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html in the *AWS Systems Manager User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html @@ -13,42 +27,64 @@ function New-VSAppConfigDeploymentStrategy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ReplicateTo + Save the deployment strategy to a Systems Manager SSM document. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-replicateto PrimitiveType: String UpdateType: Immutable .PARAMETER GrowthType + The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: +**Linear**: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. +**Exponential**: For this type, AppConfig processes the deployment exponentially using the following formula: G*2^N. In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: +2*2^0 +2*2^1 +2*2^2 +Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-growthtype PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the deployment strategy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-description PrimitiveType: String UpdateType: Mutable .PARAMETER DeploymentDurationInMinutes + Total amount of time for a deployment to last. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-deploymentdurationinminutes PrimitiveType: Double UpdateType: Mutable .PARAMETER GrowthFactor + The percentage of targets to receive a deployed configuration during each interval. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-growthfactor PrimitiveType: Double UpdateType: Mutable .PARAMETER FinalBakeTimeInMinutes + The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-finalbaketimeinminutes PrimitiveType: Double UpdateType: Mutable .PARAMETER Tags + Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-tags ItemType: Tags UpdateType: Mutable .PARAMETER Name + A name for the deployment strategy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 index bbd94b1a1..a44d8a44a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 @@ -1,10 +1,24 @@ function New-VSAppConfigEnvironment { <# .SYNOPSIS - Adds an AWS::AppConfig::Environment resource to the template. + Adds an AWS::AppConfig::Environment resource to the template. The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You define one or more environments for each AppConfig application. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration. .DESCRIPTION - Adds an AWS::AppConfig::Environment resource to the template. + Adds an AWS::AppConfig::Environment resource to the template. The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You define one or more environments for each AppConfig application. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration. + +AppConfig requires that you create resources and deploy a configuration in the following order: + +1. Create an application + +1. Create an environment + +1. Create a configuration profile + +1. Create a deployment strategy + +1. Deploy the configuration + +For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html in the *AWS Systems Manager User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html @@ -13,28 +27,38 @@ function New-VSAppConfigEnvironment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-description PrimitiveType: String UpdateType: Mutable .PARAMETER Monitors + Amazon CloudWatch alarms to monitor during the deployment process. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-monitors ItemType: Monitors UpdateType: Mutable .PARAMETER ApplicationId + The application ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-tags ItemType: Tags UpdateType: Mutable .PARAMETER Name + A name for the environment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 index e6aebcd15..a818173d6 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 @@ -94,16 +94,8 @@ After you create your service mesh, you can create virtual services, virtual nod $MeshName, [parameter(Mandatory = $false)] $Spec, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 index 1fc9ee1aa..720cb9a25 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 @@ -132,16 +132,8 @@ If your route matches a request, you can distribute traffic to one or more targe $RouteName, [parameter(Mandatory = $true)] $Spec, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 index c21c622ec..cc5ec2dea 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 @@ -6,7 +6,7 @@ function New-VSAppMeshVirtualNode { .DESCRIPTION Adds an AWS::AppMesh::VirtualNode resource to the template. Creates a virtual node within a service mesh. -A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery hostname for your task group. +A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group. Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend. @@ -120,16 +120,8 @@ If you require your Envoy stats or tracing to use a different name, you can over } })] $VirtualNodeName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 index d21f8572e..fd1993b6a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 @@ -114,16 +114,8 @@ Virtual routers handle traffic for one or more virtual services within your mesh $VirtualRouterName, [parameter(Mandatory = $true)] $Spec, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 index cc40fa3ae..86bf65f90 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 @@ -112,16 +112,8 @@ A virtual service is an abstraction of a real service that is provided by a virt $VirtualServiceName, [parameter(Mandatory = $true)] $Spec, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 index 8d302b648..147e64aeb 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 @@ -118,6 +118,12 @@ Specify a value between 60 and 360000. + stream.memory.2xlarge + stream.memory.4xlarge + stream.memory.8xlarge ++ stream.memory.z1d.large ++ stream.memory.z1d.xlarge ++ stream.memory.z1d.2xlarge ++ stream.memory.z1d.3xlarge ++ stream.memory.z1d.6xlarge ++ stream.memory.z1d.12xlarge + stream.graphics-design.large + stream.graphics-design.xlarge + stream.graphics-design.2xlarge @@ -307,16 +313,8 @@ Specify a value between 60 and 360000. } })] $InstanceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 index 26c21268a..92d95704b 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 @@ -64,7 +64,33 @@ The initial state of the image builder is PENDING. When it is ready, the state i UpdateType: Mutable .PARAMETER InstanceType - The instance type to use when launching the image builder. + The instance type to use when launching the image builder. The following instance types are available: ++ stream.standard.medium ++ stream.standard.large ++ stream.compute.large ++ stream.compute.xlarge ++ stream.compute.2xlarge ++ stream.compute.4xlarge ++ stream.compute.8xlarge ++ stream.memory.large ++ stream.memory.xlarge ++ stream.memory.2xlarge ++ stream.memory.4xlarge ++ stream.memory.8xlarge ++ stream.memory.z1d.large ++ stream.memory.z1d.xlarge ++ stream.memory.z1d.2xlarge ++ stream.memory.z1d.3xlarge ++ stream.memory.z1d.6xlarge ++ stream.memory.z1d.12xlarge ++ stream.graphics-design.large ++ stream.graphics-design.xlarge ++ stream.graphics-design.2xlarge ++ stream.graphics-design.4xlarge ++ stream.graphics-desktop.2xlarge ++ stream.graphics-pro.4xlarge ++ stream.graphics-pro.8xlarge ++ stream.graphics-pro.16xlarge Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-instancetype PrimitiveType: String @@ -93,7 +119,7 @@ The initial state of the image builder is PENDING. When it is ready, the state i UpdateType: Mutable .PARAMETER AccessEndpoints - + CreateImageBuilder: https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateImageBuilder.html in the *Amazon AppStream 2.0 API Reference* + The list of virtual private cloud VPC interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-accessendpoints @@ -215,16 +241,8 @@ The initial state of the image builder is PENDING. When it is ready, the state i } })] $InstanceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 index 0b21ad779..7089bd696 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 @@ -36,7 +36,7 @@ Deletes the storage connectors currently enabled for the stack. UpdateType: Mutable .PARAMETER EmbedHostDomains - + CreateStack: https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateStack.html in the *Amazon AppStream 2.0 API Reference* + The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions. PrimitiveItemType: String Type: List @@ -103,7 +103,7 @@ Deletes the storage connectors currently enabled for the stack. UpdateType: Mutable .PARAMETER AccessEndpoints - + CreateStack: https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateStack.html in the *Amazon AppStream 2.0 API Reference* + The list of virtual private cloud VPC interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-accessendpoints @@ -249,16 +249,8 @@ Deletes the storage connectors currently enabled for the stack. } })] $DisplayName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 index 8fc134123..e56935a48 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 @@ -1,10 +1,10 @@ function New-VSAppSyncApiCache { <# .SYNOPSIS - Adds an AWS::AppSync::ApiCache resource to the template. + Adds an AWS::AppSync::ApiCache resource to the template. Represents the input of a CreateApiCache operation. .DESCRIPTION - Adds an AWS::AppSync::ApiCache resource to the template. + Adds an AWS::AppSync::ApiCache resource to the template. Represents the input of a CreateApiCache operation. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html @@ -13,31 +13,53 @@ function New-VSAppSyncApiCache { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The cache instance type. ++ **T2_SMALL**: A t2.small instance type. ++ **T2_MEDIUM**: A t2.medium instance type. ++ **R4_LARGE**: A r4.large instance type. ++ **R4_XLARGE**: A r4.xlarge instance type. ++ **R4_2XLARGE**: A r4.2xlarge instance type. ++ **R4_4XLARGE**: A r4.4xlarge instance type. ++ **R4_8XLARGE**: A r4.8xlarge instance type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-type PrimitiveType: String UpdateType: Mutable .PARAMETER TransitEncryptionEnabled + Transit encryption flag when connecting to cache. This setting cannot be updated after creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER AtRestEncryptionEnabled + At rest encryption flag for cache. This setting cannot be updated after creation. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApiId + The GraphQL API Id. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apiid PrimitiveType: String UpdateType: Immutable .PARAMETER ApiCachingBehavior + Caching behavior. ++ **FULL_REQUEST_CACHING**: All requests are fully cached. ++ **PER_RESOLVER_CACHING**: Individual resovlers that you specify are cached. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apicachingbehavior PrimitiveType: String UpdateType: Mutable .PARAMETER Ttl + TTL in seconds for cache entries. +Valid values are between 1 and 3600 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-ttl PrimitiveType: Double UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 index 70ca7228f..734f473c5 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 @@ -20,7 +20,7 @@ function New-VSAppSyncGraphQLApi { UpdateType: Mutable .PARAMETER XrayEnabled - + CreateGraphqlApi: https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateGraphqlApi.html operation in the *AWS AppSync API Reference*. + A flag representing whether X-Ray tracing is enabled for this GraphqlApi. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 index 417e6600d..77eacffd8 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 @@ -64,14 +64,14 @@ function New-VSAppSyncResolver { UpdateType: Mutable .PARAMETER CachingConfig - + CreateResolver: https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateResolver.html operation in the *AWS AppSync API Reference*. + The caching configuration for the resolver. Type: CachingConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-cachingconfig UpdateType: Mutable .PARAMETER SyncConfig - + CreateResolver: https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateResolver.html operation in the *AWS AppSync API Reference*. + The SyncConfig for a resolver attached to a versioned datasource. Type: SyncConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-syncconfig diff --git a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 index f9169efd3..5fe6146ae 100644 --- a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 @@ -36,7 +36,8 @@ For more information, see RegisterScalableTarget: https://docs.aws.amazon.com/au UpdateType: Immutable .PARAMETER RoleARN - The Amazon Resource Name ARN of an AWS Identity and Access Management IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. + Specify the Amazon Resource Name ARN of an AWS Identity and Access Management IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling Works with IAM: https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html in the *Application Auto Scaling User Guide*. +To automatically create a service-linked role, specify the full ARN of the service-linked role in your stack template. For examples of the ARN format and more information, see Service-Linked Roles: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html in the *Application Auto Scaling User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-rolearn PrimitiveType: String @@ -51,6 +52,7 @@ For more information, see RegisterScalableTarget: https://docs.aws.amazon.com/au .PARAMETER ScheduledActions The scheduled actions for the scalable target. Duplicates aren't allowed. +For more information about using scheduled scaling, see Scheduled Scaling: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html in the *Application Auto Scaling User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scheduledactions DuplicatesAllowed: False @@ -71,7 +73,7 @@ For more information, see RegisterScalableTarget: https://docs.aws.amazon.com/au + For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. -For more information, see Suspend and Resume Application Auto Scaling: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html in the *Application Auto Scaling User Guide*. +For more information, see Suspending and Resuming Scaling: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html in the *Application Auto Scaling User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-suspendedstate Type: SuspendedState diff --git a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 index 67dff3002..59762d295 100644 --- a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 @@ -22,8 +22,10 @@ For more information, see PutScalingPolicy: https://docs.aws.amazon.com/autoscal UpdateType: Immutable .PARAMETER PolicyType - The Application Auto Scaling policy type. Valid values are StepScaling and TargetTrackingScaling. -For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported. + The Application Auto Scaling policy type. +The following policy types are supported: +TargetTrackingScaling—Not supported for Amazon EMR +StepScaling—Not supported for DynamoDB, Comprehend, or Lambda Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policytype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 index 444ed78cc..f81611fb4 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 @@ -54,7 +54,7 @@ CloudFormation marks the Auto Scaling group as successful by setting its status UpdateType: Mutable .PARAMETER HealthCheckGracePeriod - The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. + The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0. For more information, see Health Checks for Auto Scaling Instances: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html in the *Amazon EC2 Auto Scaling User Guide*. If you are adding an ELB health check, you must specify this property. diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 index 818bbc4f4..d1376a1e0 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 @@ -67,7 +67,8 @@ Valid only if the policy type is StepScaling or SimpleScaling. UpdateType: Mutable .PARAMETER PolicyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. By default, AWS CloudFormation specifies SimpleScaling. + The policy type. The default value is SimpleScaling. +*Allowed Values*: SimpleScaling, StepScaling, or TargetTrackingScaling Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-policytype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 index ecd7b2efb..81ba061e1 100644 --- a/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 @@ -126,16 +126,8 @@ When you use the AWS::CertificateManager::Certificate resource in an AWS CloudFo $DomainValidationOptions, [parameter(Mandatory = $false)] $SubjectAlternativeNames, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 b/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 index 1dfa2df2d..325302b0c 100644 --- a/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 @@ -56,7 +56,7 @@ function New-VSCloud9EnvironmentEC2 { UpdateType: Immutable .PARAMETER Tags - The name of the environment. + An array of key-value pairs that will be associated with the new AWS Cloud9 development environment. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-tags @@ -181,16 +181,8 @@ function New-VSCloud9EnvironmentEC2 { } })] $InstanceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 index ce552362f..295d07a69 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 @@ -120,16 +120,8 @@ Updates are not supported. [parameter(Mandatory = $false)] [System.Collections.Hashtable] $Parameters, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 index 6a7520eb9..0dd380af1 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFrontCloudFrontOriginAccessIdentity { <# .SYNOPSIS - Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. The request to create a new origin access identity. + Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. The request to create a new origin access identity (OAI. An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html in the *Amazon CloudFront Developer Guide*. .DESCRIPTION - Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. The request to create a new origin access identity. + Adds an AWS::CloudFront::CloudFrontOriginAccessIdentity resource to the template. The request to create a new origin access identity (OAI. An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html in the *Amazon CloudFront Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 index df289259a..f12ae65f0 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFrontDistribution { <# .SYNOPSIS - Adds an AWS::CloudFront::Distribution resource to the template. The distribution's information. + Adds an AWS::CloudFront::Distribution resource to the template. A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. .DESCRIPTION - Adds an AWS::CloudFront::Distribution resource to the template. The distribution's information. + Adds an AWS::CloudFront::Distribution resource to the template. A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html @@ -74,16 +74,8 @@ function New-VSCloudFrontDistribution { $LogicalId, [parameter(Mandatory = $true)] $DistributionConfig, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 index 5ba32f2c0..3f4445944 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 @@ -1,10 +1,10 @@ function New-VSCloudFrontStreamingDistribution { <# .SYNOPSIS - Adds an AWS::CloudFront::StreamingDistribution resource to the template. A streaming distribution. + Adds an AWS::CloudFront::StreamingDistribution resource to the template. A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery. .DESCRIPTION - Adds an AWS::CloudFront::StreamingDistribution resource to the template. A streaming distribution. + Adds an AWS::CloudFront::StreamingDistribution resource to the template. A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html @@ -74,16 +74,8 @@ function New-VSCloudFrontStreamingDistribution { $LogicalId, [parameter(Mandatory = $true)] $StreamingDistributionConfig, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $true)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 b/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 index e5777639f..c0ac6365a 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 @@ -1,10 +1,10 @@ function New-VSCloudTrailTrail { <# .SYNOPSIS - Adds an AWS::CloudTrail::Trail resource to the template. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. + Adds an AWS::CloudTrail::Trail resource to the template. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. .DESCRIPTION - Adds an AWS::CloudTrail::Trail resource to the template. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. + Adds an AWS::CloudTrail::Trail resource to the template. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html @@ -287,16 +287,8 @@ arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail } })] $SnsTopicName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 index ce144dfe2..d3f6598b4 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 @@ -17,7 +17,7 @@ When you update an existing alarm, its state is left unchanged, but the update c The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ActionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. + Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled PrimitiveType: Boolean @@ -136,7 +136,8 @@ If you specify the Metrics parameter, you cannot specify MetricName, Dimensions, UpdateType: Mutable .PARAMETER Period - The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter. + The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. +For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 new file mode 100644 index 000000000..a70058257 --- /dev/null +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 @@ -0,0 +1,237 @@ +function New-VSCloudWatchCompositeAlarm { + <# + .SYNOPSIS + Adds an AWS::CloudWatch::CompositeAlarm resource to the template. + + .DESCRIPTION + Adds an AWS::CloudWatch::CompositeAlarm resource to the template. + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html + + .PARAMETER LogicalId + The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. + + .PARAMETER AlarmName + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname + UpdateType: Immutable + PrimitiveType: String + + .PARAMETER AlarmRule + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER AlarmDescription + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER ActionsEnabled + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled + UpdateType: Mutable + PrimitiveType: Boolean + + .PARAMETER OKActions + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions + UpdateType: Mutable + Type: List + PrimitiveItemType: String + + .PARAMETER AlarmActions + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions + UpdateType: Mutable + Type: List + PrimitiveItemType: String + + .PARAMETER InsufficientDataActions + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions + UpdateType: Mutable + Type: List + PrimitiveItemType: String + + .PARAMETER DeletionPolicy + With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. + + To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. + + You must use one of the following options: "Delete","Retain","Snapshot" + + + .PARAMETER DependsOn + With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. + + This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. + + + .PARAMETER Metadata + The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. + + You must use a PSCustomObject containing key/value pairs here. This will be returned when describing the resource using AWS CLI. + + + .PARAMETER UpdatePolicy + Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. + + You must use the "Add-UpdatePolicy" function here. + .PARAMETER Condition + Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.CloudWatch.CompositeAlarm')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true,Position = 0)] + [ValidateScript( { + if ($_ -match "^[a-zA-Z0-9]*$") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String 'The LogicalID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.')) + } + })] + [System.String] + $LogicalId, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $AlarmName, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $AlarmRule, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $AlarmDescription, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Boolean","Vaporshell.Function" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $ActionsEnabled, + [parameter(Mandatory = $false)] + $OKActions, + [parameter(Mandatory = $false)] + $AlarmActions, + [parameter(Mandatory = $false)] + $InsufficientDataActions, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $DeletionPolicy, + [parameter(Mandatory = $false)] + [System.String[]] + $DependsOn, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "The UpdatePolicy parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Metadata, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.UpdatePolicy" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $UpdatePolicy, + [parameter(Mandatory = $false)] + $Condition + ) + Begin { + $ResourceParams = @{ + LogicalId = $LogicalId + Type = "AWS::CloudWatch::CompositeAlarm" + } + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + LogicalId {} + DeletionPolicy { + $ResourceParams.Add("DeletionPolicy",$DeletionPolicy) + } + DependsOn { + $ResourceParams.Add("DependsOn",$DependsOn) + } + Metadata { + $ResourceParams.Add("Metadata",$Metadata) + } + UpdatePolicy { + $ResourceParams.Add("UpdatePolicy",$UpdatePolicy) + } + Condition { + $ResourceParams.Add("Condition",$Condition) + } + OKActions { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name OKActions -Value @($OKActions) + } + AlarmActions { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name AlarmActions -Value @($AlarmActions) + } + InsufficientDataActions { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name InsufficientDataActions -Value @($InsufficientDataActions) + } + Default { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters[$key] + } + } + } + } + End { + $obj = New-VaporResource @ResourceParams + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.CloudWatch.CompositeAlarm' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$(@{$obj.LogicalId = $obj.Props} | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 index d2011611a..60304ab6e 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 @@ -6,7 +6,7 @@ function New-VSCloudWatchDashboard { .DESCRIPTION Adds an AWS::CloudWatch::Dashboard resource to the template. The AWS::CloudWatch::Dashboard resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view. -There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific. +All dashboards in your account are global, not region-specific. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 index 37ccd6da6..b49308d4f 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 @@ -1,10 +1,10 @@ function New-VSCloudWatchInsightRule { <# .SYNOPSIS - Adds an AWS::CloudWatch::InsightRule resource to the template. + Adds an AWS::CloudWatch::InsightRule resource to the template. Creates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html in the *Amazon CloudWatch User Guide*. .DESCRIPTION - Adds an AWS::CloudWatch::InsightRule resource to the template. + Adds an AWS::CloudWatch::InsightRule resource to the template. Creates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html in the *Amazon CloudWatch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html @@ -13,16 +13,22 @@ function New-VSCloudWatchInsightRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RuleState + The current state of the rule. Valid values are ENABLED and DISABLED. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate PrimitiveType: String UpdateType: Mutable .PARAMETER RuleBody + The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html in the *Amazon CloudWatch User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody PrimitiveType: String UpdateType: Mutable .PARAMETER RuleName + The name of the rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 index 7038febab..390637c68 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 @@ -45,7 +45,7 @@ You can specify either the Amazon Resource Name ARN of the CMK or, if available, .PARAMETER SourceVersion A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: -+ For AWS CodeCommit: the commit ID to use. ++ For AWS CodeCommit: the commit ID, branch, or Git tag to use. + For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID for example pr/25. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. + For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. + For Amazon Simple Storage Service Amazon S3: the version ID of the object that represents the build input ZIP file to use. @@ -122,7 +122,7 @@ Including build badges with your project is currently not supported if the sourc UpdateType: Mutable .PARAMETER FileSystemLocations - + CreateProject: https://docs.aws.amazon.com/codebuild/latest/APIReference/API_CreateProject.html in the *AWS CodeBuild API Reference* + An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-filesystemlocations @@ -345,16 +345,8 @@ These tags are available for use by AWS services that support AWS CodeBuild buil } })] $SecondarySourceVersions, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 index ba1218c89..a6d516386 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 @@ -1,10 +1,10 @@ function New-VSCodeBuildReportGroup { <# .SYNOPSIS - Adds an AWS::CodeBuild::ReportGroup resource to the template. + Adds an AWS::CodeBuild::ReportGroup resource to the template. Creates a report group. A report group contains a collection of reports. .DESCRIPTION - Adds an AWS::CodeBuild::ReportGroup resource to the template. + Adds an AWS::CodeBuild::ReportGroup resource to the template. Creates a report group. A report group contains a collection of reports. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html @@ -13,16 +13,22 @@ function New-VSCodeBuildReportGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of the ReportGroup. The one valid value is TEST. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-type PrimitiveType: String UpdateType: Mutable .PARAMETER ExportConfig + Information about the destination where the raw data of this ReportGroup is exported. + Type: ReportExportConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-exportconfig UpdateType: Mutable .PARAMETER Name + The name of a ReportGroup. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 index b965a533d..3340ef2d6 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 @@ -1,10 +1,10 @@ function New-VSCodeBuildSourceCredential { <# .SYNOPSIS - Adds an AWS::CodeBuild::SourceCredential resource to the template. Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials or the NoEcho parameter to mask your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. + Adds an AWS::CodeBuild::SourceCredential resource to the template. Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. .DESCRIPTION - Adds an AWS::CodeBuild::SourceCredential resource to the template. Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials or the NoEcho parameter to mask your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. + Adds an AWS::CodeBuild::SourceCredential resource to the template. Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. **Important** diff --git a/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 b/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 index 5cde70e25..d2063fae6 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 @@ -14,7 +14,7 @@ function New-VSCodeCommitRepository { .PARAMETER RepositoryName The name of the new repository to be created. -The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html in the AWS CodeCommit User Guide. The suffix ".git" is prohibited. +The repository name must be unique across the calling AWS account. Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about the limits on repository names, see Limits: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html in the *AWS CodeCommit User Guide*. The suffix .git is prohibited. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositoryname PrimitiveType: String @@ -37,7 +37,7 @@ The repository name must be unique across the calling AWS account. In addition, .PARAMETER RepositoryDescription A comment or description about the new repository. -The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. +The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositorydescription PrimitiveType: String @@ -131,16 +131,8 @@ The description field for a repository accepts all HTML characters and all valid } })] $RepositoryDescription, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 index 614a60e1e..5f28d02aa 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 @@ -50,7 +50,7 @@ function New-VSCodeDeployDeploymentGroup { UpdateType: Mutable .PARAMETER DeploymentConfigName - A deployment configuration name or a predefined configuration name. With predefined configurations, you can deploy application revisions to one instance at a time, half of the instances at a time, or all the instances at once. For more information and valid values, see Working with Deployment Configurations: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html in the *AWS CodeDeploy User Guide*. + A deployment configuration name or a predefined configuration name. With predefined configurations, you can deploy application revisions to one instance at a time CodeDeployDefault.OneAtATime, half of the instances at a time CodeDeployDefault.HalfAtATime, or all the instances at once CodeDeployDefault.AllAtOnce. For more information and valid values, see Working with Deployment Configurations: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html in the *AWS CodeDeploy User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentconfigname PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 index 6d752c3b4..7c64cb19c 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 @@ -14,7 +14,6 @@ function New-VSCodePipelineCustomActionType { .PARAMETER Category The category of the custom action, such as a build action or a test action. -Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category PrimitiveType: String @@ -59,6 +58,8 @@ You can refer to a name in the configuration properties of the custom action wit UpdateType: Immutable .PARAMETER Tags + The tags for the custom action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags DuplicatesAllowed: True ItemType: Tag @@ -156,16 +157,8 @@ You can refer to a name in the configuration properties of the custom action wit $Provider, [parameter(Mandatory = $false)] $Settings, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 index 50eded61f..b6b0788b5 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 @@ -13,15 +13,16 @@ function New-VSCodePipelinePipeline { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ArtifactStore - The Amazon S3 bucket where artifacts are stored for the pipeline. + The S3 bucket where artifacts for the pipeline are stored. +You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore Type: ArtifactStore UpdateType: Mutable .PARAMETER ArtifactStores - A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. -If you create a cross-region action in your pipeline, you must use artifactStores. + A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. +You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores DuplicatesAllowed: False @@ -69,6 +70,8 @@ If you create a cross-region action in your pipeline, you must use artifactStore UpdateType: Mutable .PARAMETER Tags + Specifies the tags applied to the pipeline. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags DuplicatesAllowed: True ItemType: Tag @@ -188,16 +191,8 @@ If you create a cross-region action in your pipeline, you must use artifactStore } })] $Stages, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 index b6c53204a..ed72a2151 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 @@ -6,6 +6,12 @@ function New-VSCodePipelineWebhook { .DESCRIPTION Adds an AWS::CodePipeline::Webhook resource to the template. The AWS::CodePipeline::Webhook resource creates and registers your webhook. After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see Configure Your GitHub Pipelines to Use Webhooks for Change Detection: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-webhooks-migration.html in the *AWS CodePipeline User Guide*. +We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see Using Dynamic References to Specify Template Values: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager. + +**Important** + +When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html @@ -28,10 +34,10 @@ function New-VSCodePipelineWebhook { UpdateType: Mutable .PARAMETER Authentication - Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED. + Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. + For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks: https://developer.github.com/webhooks/securing/ on the GitHub Developer website. -+ IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration. -+ UNAUTHENTICATED will accept all webhook trigger requests regardless of origin. ++ IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. ++ UNAUTHENTICATED accepts all webhook trigger requests regardless of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 b/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 index 676dfdfaa..da6324282 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 @@ -1,10 +1,10 @@ function New-VSCodeStarNotificationsNotificationRule { <# .SYNOPSIS - Adds an AWS::CodeStarNotifications::NotificationRule resource to the template. + Adds an AWS::CodeStarNotifications::NotificationRule resource to the template. Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics where you want to receive them. .DESCRIPTION - Adds an AWS::CodeStarNotifications::NotificationRule resource to the template. + Adds an AWS::CodeStarNotifications::NotificationRule resource to the template. Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics where you want to receive them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html @@ -13,38 +13,52 @@ function New-VSCodeStarNotificationsNotificationRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EventTypeIds + A list of event types associated with this notification rule. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeids UpdateType: Mutable .PARAMETER Status + The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-status PrimitiveType: String UpdateType: Mutable .PARAMETER DetailType + The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-detailtype PrimitiveType: String UpdateType: Mutable .PARAMETER Resource + The Amazon Resource Name ARN of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource PrimitiveType: String UpdateType: Immutable .PARAMETER Targets + A list of Amazon Resource Names ARNs of SNS topics to associate with the notification rule. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targets ItemType: Target UpdateType: Mutable .PARAMETER Tags + A list of tags to apply to this notification rule. Key names cannot start with "aws". + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-tags PrimitiveType: Json UpdateType: Immutable .PARAMETER Name + The name for the notification rule. Notification rule names must be unique in your AWS account. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 index 89ab5e448..fbf3d161d 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 @@ -6,6 +6,8 @@ function New-VSCognitoIdentityPool { .DESCRIPTION Adds an AWS::Cognito::IdentityPool resource to the template. The AWS::Cognito::IdentityPool resource creates an Amazon Cognito identity pool. +To avoid deleting the resource accidentally from AWS CloudFormation, use DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html and the UpdateReplacePolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html to retain the resource on deletion or replacement. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html @@ -13,14 +15,14 @@ function New-VSCognitoIdentityPool { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PushSync - Configuration options to be applied to the identity pool. + The configuration options to be applied to the identity pool. Type: PushSync Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-pushsync UpdateType: Mutable .PARAMETER CognitoIdentityProviders - An array of Amazon Cognito user pools and their client IDs. + The Amazon Cognito user pools and their client IDs. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoidentityproviders @@ -35,7 +37,7 @@ function New-VSCognitoIdentityPool { UpdateType: Mutable .PARAMETER DeveloperProviderName - The "domain" by which Amazon Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters and periods ., underscores _, and dashes -. + The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters and periods ., underscores _, and dashes -. *Minimum length*: 1 *Maximum length*: 100 @@ -54,7 +56,7 @@ function New-VSCognitoIdentityPool { The name of your Amazon Cognito identity pool. *Minimum length*: 1 *Maximum length*: 128 -*Pattern*: w ]+ +*Pattern*: ws+=,.@-]+ Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypoolname PrimitiveType: String @@ -75,7 +77,7 @@ function New-VSCognitoIdentityPool { UpdateType: Mutable .PARAMETER SamlProviderARNs - A list of Amazon Resource Names ARNs of Security Assertion Markup Language SAML providers. + The Amazon Resource Names ARNs of the Security Assertion Markup Language SAML providers. PrimitiveItemType: String Type: List @@ -83,7 +85,7 @@ function New-VSCognitoIdentityPool { UpdateType: Mutable .PARAMETER OpenIdConnectProviderARNs - A list of ARNs for the OpendID Connect provider. + The Amazon Resource Names ARNs of the OpenID connect providers. PrimitiveItemType: String Type: List @@ -91,7 +93,7 @@ function New-VSCognitoIdentityPool { UpdateType: Mutable .PARAMETER AllowClassicFlow - The name of the Amazon Cognito identity pool, returned as a string. + Enables the Basic Classic authentication flow. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowclassicflow PrimitiveType: Boolean diff --git a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 index 97fdea566..d9babe480 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 @@ -13,7 +13,8 @@ function New-VSCognitoIdentityPoolRoleAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RoleMappings - How users for a specific identity provider are mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id" + How users for a specific identity provider are mapped to roles. This is a string to the RoleMapping object map. The string identifies the identity provider. For example: "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". +If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-rolemappings PrimitiveType: Json @@ -27,7 +28,7 @@ function New-VSCognitoIdentityPoolRoleAttachment { UpdateType: Immutable .PARAMETER Roles - The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. + The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-roles PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 index a8b024870..0b6965a74 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 @@ -34,17 +34,18 @@ function New-VSCognitoUserPool { UpdateType: Mutable .PARAMETER MfaConfiguration - Specifies multi-factor authentication MFA configuration details. Can be one of the following values: -OFF - MFA tokens are not required and cannot be specified during user registration. -ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. -OPTIONAL - Users have the option when registering to create an MFA token. + The multi-factor MFA configuration. Valid values include: ++ OFF MFA will not be used for any users. ++ ON MFA is required for all users to sign in. ++ OPTIONAL MFA will be required only for individual users who have an MFA factor enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration PrimitiveType: String UpdateType: Mutable .PARAMETER Schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + The schema attributes for the new user pool. These attributes can be standard or custom attributes. +During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema @@ -52,7 +53,7 @@ OPTIONAL - Users have the option when registering to create an MFA token. UpdateType: Mutable .PARAMETER AdminCreateUserConfig - The type of configuration for creating a new user profile. + The configuration for creating a new user profile. Type: AdminCreateUserConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig @@ -66,7 +67,7 @@ OPTIONAL - Users have the option when registering to create an MFA token. UpdateType: Mutable .PARAMETER UsernameConfiguration - The URL of the provider of the Amazon Cognito user pool, specified as a String. + You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. Type: UsernameConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration @@ -109,6 +110,7 @@ OPTIONAL - Users have the option when registering to create an MFA token. .PARAMETER AliasAttributes Attributes supported as an alias for this user pool. Possible values: **phone_number**, **email**, or **preferred_username**. +This user pool property cannot be updated. PrimitiveItemType: String Type: List @@ -116,7 +118,10 @@ OPTIONAL - Users have the option when registering to create an MFA token. UpdateType: Mutable .PARAMETER EnabledMfas - The URL of the provider of the Amazon Cognito user pool, specified as a String. + Enables MFA on a specified user pool. To disable all MFAs after it has been enabled, set MfaConfiguration to “OFF” and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values: ++ SMS_MFA - Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided. ++ SOFTWARE_TOKEN_MFA - Enables software token MFA for the user pool. +Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA PrimitiveItemType: String Type: List @@ -141,7 +146,8 @@ For adding permission using the AWS CLI, see add-permission : https://docs.aws. UpdateType: Mutable .PARAMETER UsernameAttributes - Specifies whether email addresses or phone numbers can be specified as user names when a user signs up. Possible values: phone_number or email. + Determines whether email addresses or phone numbers can be specified as user names when a user signs up. Possible values: phone_number or email. +This user pool property cannot be updated. PrimitiveItemType: String Type: List @@ -157,7 +163,7 @@ For adding permission using the AWS CLI, see add-permission : https://docs.aws. UpdateType: Mutable .PARAMETER DeviceConfiguration - The type of configuration for the user pool's device tracking. + The device configuration. Type: DeviceConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration @@ -171,7 +177,7 @@ For adding permission using the AWS CLI, see add-permission : https://docs.aws. UpdateType: Mutable .PARAMETER AccountRecoverySetting - The URL of the provider of the Amazon Cognito user pool, specified as a String. + Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email. Type: AccountRecoverySetting Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 index 4e25fd5a4..3c0e37d41 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolClient { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolClient resource to the template. The AWS::Cognito::UserPoolClient resource creates an Amazon Cognito user pool client. + Adds an AWS::Cognito::UserPoolClient resource to the template. The AWS::Cognito::UserPoolClient resource specifies an Amazon Cognito user pool client. .DESCRIPTION - Adds an AWS::Cognito::UserPoolClient resource to the template. The AWS::Cognito::UserPoolClient resource creates an Amazon Cognito user pool client. + Adds an AWS::Cognito::UserPoolClient resource to the template. The AWS::Cognito::UserPoolClient resource specifies an Amazon Cognito user pool client. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html @@ -14,6 +14,7 @@ function New-VSCognitoUserPoolClient { .PARAMETER AnalyticsConfiguration The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. +Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East N. Virginia us-east-1 Region, regardless of the region in which the user pool resides. Type: AnalyticsConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration @@ -42,7 +43,7 @@ App callback URLs such as myapp://example are also supported. UpdateType: Mutable .PARAMETER AllowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". + The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported. PrimitiveItemType: String Type: List @@ -58,7 +59,7 @@ App callback URLs such as myapp://example are also supported. UpdateType: Mutable .PARAMETER AllowedOAuthFlowsUserPoolClient - Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. + Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient PrimitiveType: Boolean @@ -101,8 +102,10 @@ App callback URLs such as myapp://example are also supported. UpdateType: Immutable .PARAMETER AllowedOAuthFlows - Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. -Set to token to specify that the client should get the access token and, optionally, ID token, based on scopes directly. + The allowed OAuth flows. +Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. +Set to implicit to specify that the client should get the access token and, optionally, ID token, based on scopes directly. +Set to client_credentials to specify that the client should get the access token and, optionally, ID token, based on scopes from the token endpoint using a combination of client and client_secret. PrimitiveItemType: String Type: List @@ -110,7 +113,13 @@ Set to token to specify that the client should get the access token and, optiona UpdateType: Mutable .PARAMETER ExplicitAuthFlows - The explicit authentication flows, which can be one of the following: ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. + The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix. +Valid values include: ++ ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP Secure Remote Password protocol protocol to verify passwords. ++ ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. ++ ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords. ++ ALLOW_USER_SRP_AUTH: Enable SRP based authentication. ++ ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. PrimitiveItemType: String Type: List @@ -142,7 +151,7 @@ If your app client allows users to sign in through an identity provider, this ar UpdateType: Mutable .PARAMETER PreventUserExistenceErrors - For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-preventuserexistenceerrors PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 index 9a98d887d..bb8a731bd 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolDomain { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolDomain resource to the template. + Adds an AWS::Cognito::UserPoolDomain resource to the template. The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool. .DESCRIPTION - Adds an AWS::Cognito::UserPoolDomain resource to the template. + Adds an AWS::Cognito::UserPoolDomain resource to the template. The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html @@ -13,16 +13,23 @@ function New-VSCognitoUserPoolDomain { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER UserPoolId + The user pool ID for the user pool where you want to associate a user pool domain. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER CustomDomainConfig + The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. + Type: CustomDomainConfigType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig UpdateType: Mutable .PARAMETER Domain + The domain name for the domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com. If you're using a prefix domain, this field denotes the first part of the domain before .auth.region].amazoncognito.com. +This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-domain PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 index 32317a1f4..ebe62c572 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 @@ -1,10 +1,12 @@ function New-VSCognitoUserPoolGroup { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolGroup resource to the template. The AWS::Cognito::UserPoolGroup resource creates a user group in an Amazon Cognito user pool. + Adds an AWS::Cognito::UserPoolGroup resource to the template. Specifies a new group in the identified user pool. .DESCRIPTION - Adds an AWS::Cognito::UserPoolGroup resource to the template. The AWS::Cognito::UserPoolGroup resource creates a user group in an Amazon Cognito user pool. + Adds an AWS::Cognito::UserPoolGroup resource to the template. Specifies a new group in the identified user pool. + +Calling this action requires developer credentials. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 index 8a64295e0..55cd2d40d 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolIdentityProvider { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolIdentityProvider resource to the template. + Adds an AWS::Cognito::UserPoolIdentityProvider resource to the template. The AWS::Cognito::UserPoolIdentityProvider resource creates an identity provider for a user pool. .DESCRIPTION - Adds an AWS::Cognito::UserPoolIdentityProvider resource to the template. + Adds an AWS::Cognito::UserPoolIdentityProvider resource to the template. The AWS::Cognito::UserPoolIdentityProvider resource creates an identity provider for a user pool. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html @@ -13,31 +13,66 @@ function New-VSCognitoUserPoolIdentityProvider { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ProviderName + The identity provider name. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providername PrimitiveType: String UpdateType: Immutable .PARAMETER UserPoolId + The user pool ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER AttributeMapping + A mapping of identity provider attributes to standard and custom user pool attributes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-attributemapping PrimitiveType: Json UpdateType: Mutable .PARAMETER ProviderDetails + The identity provider details. The following list describes the provider detail keys for each identity provider type. ++ For Google, Facebook and Login with Amazon: ++ client_id ++ client_secret ++ authorize_scopes ++ For Sign in with Apple: ++ client_id ++ team_id ++ key_id ++ private_key ++ authorize_scopes ++ For OIDC providers: ++ client_id ++ client_secret ++ attributes_request_method ++ oidc_issuer ++ authorize_scopes ++ authorize_url *if not available from discovery URL specified by oidc_issuer key* ++ token_url *if not available from discovery URL specified by oidc_issuer key* ++ attributes_url *if not available from discovery URL specified by oidc_issuer key* ++ jwks_uri *if not available from discovery URL specified by oidc_issuer key* ++ For SAML providers: ++ MetadataFile OR MetadataURL ++ IDPSignout *optional* + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providerdetails PrimitiveType: Json UpdateType: Mutable .PARAMETER ProviderType + The identity provider type. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providertype PrimitiveType: String UpdateType: Immutable .PARAMETER IdpIdentifiers + A list of identity provider identifiers. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-idpidentifiers diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 index b171e45cb..2d00fa24a 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 @@ -1,10 +1,10 @@ function New-VSCognitoUserPoolResourceServer { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolResourceServer resource to the template. + Adds an AWS::Cognito::UserPoolResourceServer resource to the template. The AWS::Cognito::UserPoolResourceServer resource creates a new OAuth2.0 resource server and defines custom scopes in it. .DESCRIPTION - Adds an AWS::Cognito::UserPoolResourceServer resource to the template. + Adds an AWS::Cognito::UserPoolResourceServer resource to the template. The AWS::Cognito::UserPoolResourceServer resource creates a new OAuth2.0 resource server and defines custom scopes in it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html @@ -13,22 +13,30 @@ function New-VSCognitoUserPoolResourceServer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER UserPoolId + The user pool ID for the user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER Identifier + A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example: https://my-weather-api.example.com. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-identifier PrimitiveType: String UpdateType: Immutable .PARAMETER Scopes + The scopes. Each scope is a map, where the keys are name and the values are description for the scope. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-scopes ItemType: ResourceServerScopeType UpdateType: Mutable .PARAMETER Name + A friendly name for the resource server. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 index ae1df87e2..1a1722dc6 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 @@ -1,10 +1,12 @@ function New-VSCognitoUserPoolRiskConfigurationAttachment { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment resource to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment resource to the template. The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features. .DESCRIPTION - Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment resource to the template. + Adds an AWS::Cognito::UserPoolRiskConfigurationAttachment resource to the template. The AWS::Cognito::UserPoolRiskConfigurationAttachment resource sets the risk configuration that is used for Amazon Cognito advanced security features. + +You can specify risk configuration for a single client (with a specific clientId or for all clients (by setting the clientId to ALL. If you specify ALL, the default configuration is used for every client that has had no risk configuration set previously. If you specify risk configuration for a particular client, it no longer falls back to the ALL configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html @@ -13,26 +15,36 @@ function New-VSCognitoUserPoolRiskConfigurationAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CompromisedCredentialsRiskConfiguration + The compromised credentials risk configuration object including the EventFilter and the EventAction + Type: CompromisedCredentialsRiskConfigurationType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration UpdateType: Mutable .PARAMETER UserPoolId + The user pool ID. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER ClientId + The app client ID. You can specify the risk configuration for a single client with a specific ClientId or for all clients by setting the ClientId to ALL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-clientid PrimitiveType: String UpdateType: Immutable .PARAMETER AccountTakeoverRiskConfiguration + The account takeover risk configuration object including the NotifyConfiguration object and Actions to take in the case of an account takeover. + Type: AccountTakeoverRiskConfigurationType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration UpdateType: Mutable .PARAMETER RiskExceptionConfiguration + The configuration to override the risk decision. + Type: RiskExceptionConfigurationType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 index 5f125e441..0e6ed4d37 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 @@ -1,10 +1,18 @@ function New-VSCognitoUserPoolUICustomizationAttachment { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolUICustomizationAttachment resource to the template. + Adds an AWS::Cognito::UserPoolUICustomizationAttachment resource to the template. The AWS::Cognito::UserPoolUICustomizationAttachment resource sets the UI customization information for a user pool's built-in app UI. .DESCRIPTION - Adds an AWS::Cognito::UserPoolUICustomizationAttachment resource to the template. + Adds an AWS::Cognito::UserPoolUICustomizationAttachment resource to the template. The AWS::Cognito::UserPoolUICustomizationAttachment resource sets the UI customization information for a user pool's built-in app UI. + +You can specify app UI customization settings for a single client (with a specific clientId or for all clients (by setting the clientId to ALL. If you specify ALL, the default configuration is used for every client that has had no UI customization set previously. If you specify UI customization settings for a particular client, it no longer falls back to the ALL configuration. + +**Note** + +Before you create this resource, your user pool must have a domain associated with it. You can create an AWS::Cognito::UserPoolDomain resource first in this user pool. + +Setting a logo image isn't supported from AWS CloudFormation. Use the Amazon Cognito SetUICustomization: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUICustomization.html#API_SetUICustomization_RequestSyntax API operation to set the image. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html @@ -13,16 +21,22 @@ function New-VSCognitoUserPoolUICustomizationAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CSS + The CSS values in the UI customization. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-css PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId + The user pool ID for the user pool. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-userpoolid PrimitiveType: String UpdateType: Immutable .PARAMETER ClientId + The client ID for the client app. You can specify the UI customization settings for a single client with a specific clientId or for all clients by setting the clientId to ALL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-clientid PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 index e7f7ff3be..7b23cb34e 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 @@ -44,7 +44,13 @@ The user's validation data is not persisted. UpdateType: Immutable .PARAMETER ClientMetadata - For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the *pre sign-up* trigger. +You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you create a UserPoolUser resource and include the ClientMetadata property, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata property. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. +For more information, see Customizing User Pool Workflows with Lambda Triggers: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html in the *Amazon Cognito Developer Guide*. +Take the following limitations into consideration when you use the ClientMetadata parameter: ++ Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. ++ Amazon Cognito does not validate the ClientMetadata value. ++ Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata PrimitiveType: Json @@ -68,12 +74,12 @@ If this parameter is set to False, the API throws an AliasExistsException error UpdateType: Immutable .PARAMETER UserAttributes - An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required in https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html or in the **Attributes** tab of the console must be supplied either by you in your call to AdminCreateUser or by the user when he or she signs up in response to your welcome message. + The user attributes and attribute values to be set for the user to be created. These are name-value pairs You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required in https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html or in the **Attributes** tab of the console must be supplied either by you in your call to AdminCreateUser or by the user when they sign up in response to your welcome message. For custom attributes, you must prepend the custom: prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the **Users** tab of the Amazon Cognito console for managing your user pools. In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html. -+ **email**: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. -+ **phone_number**: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter. ++ **email**: The email address of the user to whom the message that contains the code and user name will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. ++ **phone_number**: The phone number of the user to whom the message that contains the code and user name will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 index 7f9289545..c6912ba6b 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 @@ -1,10 +1,12 @@ function New-VSCognitoUserPoolUserToGroupAttachment { <# .SYNOPSIS - Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. The AWS::Cognito::UserPoolUserToGroupAttachment resource attaches a user to an Amazon Cognito user pool user group. + Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. Adds the specified user to the specified group. .DESCRIPTION - Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. The AWS::Cognito::UserPoolUserToGroupAttachment resource attaches a user to an Amazon Cognito user pool user group. + Adds an AWS::Cognito::UserPoolUserToGroupAttachment resource to the template. Adds the specified user to the specified group. + +Calling this action requires developer credentials. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html diff --git a/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 b/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 index 8b62930ff..e660b3d75 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 @@ -99,16 +99,8 @@ function New-VSConfigAggregationAuthorization { } })] $AuthorizedAwsRegion, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 index 58da2e9b8..88070f9dd 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 @@ -109,16 +109,8 @@ function New-VSConfigConfigurationAggregator { $ConfigurationAggregatorName, [parameter(Mandatory = $false)] $OrganizationAggregationSource, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 index 749d0e7c6..54152a0ae 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 @@ -8,7 +8,7 @@ function New-VSConfigConfigurationRecorder { **Note** -To enable AWS Config, you must create a configuration recorder and a delivery channel. AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon SNS topic. For more information, see AWS::Config::DeliveryChannel: https://docs.aws.amazon.com/config/latest/UserGuide/aws-resource-config-deliverychannel.html. +To enable AWS Config, you must create a configuration recorder and a delivery channel. AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon SNS topic. For more information, see AWS::Config::DeliveryChannel: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html. AWS CloudFormation starts the recorder as soon as the delivery channel is available. To stop the recorder, delete the configuration recorder from your stack. For more information, see Configuration Recorder: https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#config-recorder in the AWS Config Developer Guide. diff --git a/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 index 8969f7225..5103d782b 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 @@ -1,10 +1,10 @@ function New-VSConfigConformancePack { <# .SYNOPSIS - Adds an AWS::Config::ConformancePack resource to the template. + Adds an AWS::Config::ConformancePack resource to the template. A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed in an account and a region. ConformancePack creates a service linked role in your account. The service linked role is created only when the role does not exist in your account. .DESCRIPTION - Adds an AWS::Config::ConformancePack resource to the template. + Adds an AWS::Config::ConformancePack resource to the template. A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed in an account and a region. ConformancePack creates a service linked role in your account. The service linked role is created only when the role does not exist in your account. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html @@ -13,31 +13,45 @@ function New-VSConfigConformancePack { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConformancePackName + Name of the conformance pack you want to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-conformancepackname UpdateType: Immutable PrimitiveType: String .PARAMETER DeliveryS3Bucket + AWS Config stores intermediate files while processing conformance pack template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-deliverys3bucket UpdateType: Mutable PrimitiveType: String .PARAMETER DeliveryS3KeyPrefix + The prefix for the Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-deliverys3keyprefix UpdateType: Mutable PrimitiveType: String .PARAMETER TemplateBody + A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. +You can only use a YAML template with one resource type, that is, config rule and a remediation action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-templatebody UpdateType: Mutable PrimitiveType: String .PARAMETER TemplateS3Uri + Location of file containing the template body s3://bucketname/prefix. The uri must point to the conformance pack template max size: 300 KB that is located in an Amazon S3 bucket. +You must have access to read Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-templates3uri UpdateType: Mutable PrimitiveType: String .PARAMETER ConformancePackInputParameters + A list of ConformancePackInputParameter objects. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-conformancepackinputparameters UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 index f184957e3..2b8f514ff 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 @@ -1,10 +1,10 @@ function New-VSConfigOrganizationConformancePack { <# .SYNOPSIS - Adds an AWS::Config::OrganizationConformancePack resource to the template. + Adds an AWS::Config::OrganizationConformancePack resource to the template. OrganizationConformancePack deploys conformance packs across member accounts in an AWS Organization. OrganizationConformancePack enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role in the master account of your organization. The service linked role is created only when the role does not exist in the master account. .DESCRIPTION - Adds an AWS::Config::OrganizationConformancePack resource to the template. + Adds an AWS::Config::OrganizationConformancePack resource to the template. OrganizationConformancePack deploys conformance packs across member accounts in an AWS Organization. OrganizationConformancePack enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role in the master account of your organization. The service linked role is created only when the role does not exist in the master account. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html @@ -13,37 +13,51 @@ function New-VSConfigOrganizationConformancePack { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER OrganizationConformancePackName + The name you assign to an organization conformance pack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-organizationconformancepackname UpdateType: Immutable PrimitiveType: String .PARAMETER TemplateS3Uri + Location of file containing the template body. The uri must point to the conformance pack template max size: 300 KB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-templates3uri UpdateType: Mutable PrimitiveType: String .PARAMETER TemplateBody + A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-templatebody UpdateType: Mutable PrimitiveType: String .PARAMETER DeliveryS3Bucket + Location of an Amazon S3 bucket where AWS Config can deliver evaluation results and conformance pack template that is used to create a pack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-deliverys3bucket UpdateType: Mutable PrimitiveType: String .PARAMETER DeliveryS3KeyPrefix + Any folder structure you want to add to an Amazon S3 bucket. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-deliverys3keyprefix UpdateType: Mutable PrimitiveType: String .PARAMETER ConformancePackInputParameters + A list of ConformancePackInputParameter objects. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-conformancepackinputparameters UpdateType: Mutable Type: List ItemType: ConformancePackInputParameter .PARAMETER ExcludedAccounts + A comma-separated list of accounts excluded from organization conformance pack. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-excludedaccounts UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 index c7159e93d..60924eabd 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 @@ -20,6 +20,8 @@ function New-VSConfigRemediationConfiguration { UpdateType: Mutable .PARAMETER ExecutionControls + An ExecutionControls object. + Type: ExecutionControls Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-executioncontrols UpdateType: Mutable @@ -54,11 +56,17 @@ The type is a map of strings to RemediationParameterValue. UpdateType: Mutable .PARAMETER RetryAttemptSeconds + Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds. +For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-retryattemptseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaximumAutomaticAttempts + The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5. +For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, AWS Config throws an exception after the 5th failed attempt within 50 seconds. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-maximumautomaticattempts PrimitiveType: Integer UpdateType: Mutable @@ -71,6 +79,8 @@ The type is a map of strings to RemediationParameterValue. UpdateType: Mutable .PARAMETER Automatic + The remediation is triggered automatically. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-automatic PrimitiveType: Boolean UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 b/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 index 7dafbb79d..0c9ce09c6 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 @@ -27,7 +27,7 @@ function New-VSDAXCluster { UpdateType: Mutable .PARAMETER ReplicationFactor - The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set *ReplicationFactor* to 2 or more. + The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 one primary and two read replicas and 10 one primary and nine read replicas. If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor. AWS recommends that you have at least two read replicas per cluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-replicationfactor @@ -42,7 +42,7 @@ AWS recommends that you have at least two read replicas per cluster. UpdateType: Mutable .PARAMETER AvailabilityZones - The Availability Zones AZs in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs. + The Availability Zones AZs in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. PrimitiveItemType: String Type: List @@ -51,7 +51,6 @@ AWS recommends that you have at least two read replicas per cluster. .PARAMETER IAMRoleARN A valid Amazon Resource Name ARN that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf. -Updates are not supported for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-iamrolearn PrimitiveType: String @@ -60,7 +59,6 @@ Updates are not supported for this property. .PARAMETER SubnetGroupName The name of the subnet group to be used for the replication group. DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC. -Updates are not supported for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-subnetgroupname PrimitiveType: String @@ -92,7 +90,6 @@ If this parameter is not specified, DAX assigns the default VPC security group t .PARAMETER NodeType The node type for the nodes in the cluster. All nodes in a DAX cluster are of the same type. -Updates are not supported for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-nodetype PrimitiveType: String @@ -100,7 +97,6 @@ Updates are not supported for this property. .PARAMETER ClusterName The name of the DAX cluster. -Updates are not supported for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clustername PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 index 055c366f7..50752fff0 100644 --- a/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 @@ -37,7 +37,6 @@ The properties are required when you add a lifecycle policy and optional when yo .PARAMETER PolicyDetails The configuration details of the lifecycle policy. -Target tags cannot be re-used across lifecycle policies. Type: PolicyDetails Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-policydetails diff --git a/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 index 9fe923ae7..3a2e98c5b 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 @@ -13,21 +13,21 @@ function New-VSDMSCertificate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CertificateIdentifier - The customer-assigned name of the certificate. Valid characters are A-z and 0-9. + A customer-assigned name for the certificate. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificateidentifier PrimitiveType: String UpdateType: Immutable .PARAMETER CertificatePem - The contents of the .pem X.509 certificate file for the certificate. + The contents of a .pem file, which contains an X.509 certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatepem PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateWallet - The location of the imported Oracle Wallet certificate for use with SSL. + The location of an imported Oracle Wallet certificate for use with SSL. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatewallet PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 index 9195c0f73..1bfc442de 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 @@ -13,7 +13,9 @@ function New-VSDMSEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KmsKeyId - The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. + An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. +If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. +AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid PrimitiveType: String @@ -48,7 +50,7 @@ function New-VSDMSEndpoint { UpdateType: Mutable .PARAMETER EngineName - The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver. + The type of engine for the endpoint. Valid values, depending on the EndpointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename PrimitiveType: String @@ -62,7 +64,7 @@ function New-VSDMSEndpoint { UpdateType: Mutable .PARAMETER KinesisSettings - Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping in the *AWS Database Migration User Guide.* + Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping in the *AWS Database Migration User Guide.* Type: KinesisSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings @@ -76,7 +78,7 @@ function New-VSDMSEndpoint { UpdateType: Mutable .PARAMETER SslMode - The Secure Sockets Layer SSL mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none. + The Secure Sockets Layer SSL mode to use for the SSL connection. The default is none Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode PrimitiveType: String @@ -90,21 +92,21 @@ function New-VSDMSEndpoint { UpdateType: Mutable .PARAMETER ExtraConnectionAttributes - Additional attributes associated with the connection. + Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign =. Multiple attributes are separated by a semicolon ; with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html in the *AWS Database Migration Service User Guide.* Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes PrimitiveType: String UpdateType: Mutable .PARAMETER EndpointType - The type of endpoint. + The type of endpoint. Valid values are source and target. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER Tags - Tags to be added to the endpoint. + One or more tags to be assigned to the endpoint. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags @@ -293,16 +295,8 @@ function New-VSDMSEndpoint { } })] $EndpointType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 index 421501544..95776a2d1 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 @@ -14,7 +14,7 @@ function New-VSDMSEventSubscription { .PARAMETER SourceType The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned. -Valid values: replication-instance | migration-task +Valid values: replication-instance | replication-task Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype PrimitiveType: String @@ -36,8 +36,7 @@ Valid values: replication-instance | migration-task UpdateType: Mutable .PARAMETER SubscriptionName - The name of the AWS DMS event notification subscription. -Constraints: The name must be less than 255 characters. + The name of the AWS DMS event notification subscription. This name must be less than 255 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname PrimitiveType: String @@ -51,7 +50,9 @@ Constraints: The name must be less than 255 characters. UpdateType: Mutable .PARAMETER SourceIds - The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. + A list of identifiers for which AWS DMS provides notification events. +If you don't specify a value, notifications are provided for all sources. +If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs. PrimitiveItemType: String Type: List @@ -59,7 +60,7 @@ Constraints: The name must be less than 255 characters. UpdateType: Immutable .PARAMETER Tags - A tag to be attached to the event subscription. + One or more tags to be assigned to the event subscription. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags @@ -159,16 +160,8 @@ Constraints: The name must be less than 255 characters. $SnsTopicArn, [parameter(Mandatory = $false)] $SourceIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 index cb8c4a4a0..3726d3c6d 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 @@ -32,7 +32,9 @@ Example: myrepinstance UpdateType: Mutable .PARAMETER KmsKeyId - The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. + An AWS KMS key identifier that is used to encrypt the data on the replication instance. +If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. +AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-kmskeyid PrimitiveType: String @@ -49,7 +51,7 @@ The default value is a random, system-chosen Availability Zone in the endpoint's .PARAMETER PreferredMaintenanceWindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time UTC. Format: ddd:hh24:mi-ddd:hh24:mi -Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. +Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. @@ -58,7 +60,7 @@ Constraints: Minimum 30-minute window. UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. + Indicates whether minor engine upgrades will be applied automatically to the replication instance during the maintenance window. This parameter defaults to true. Default: true Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-autominorversionupgrade @@ -88,8 +90,8 @@ Default: true UpdateType: Mutable .PARAMETER AllowMajorVersionUpgrade - Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. -Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version. + Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible. +This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allowmajorversionupgrade PrimitiveType: Boolean @@ -111,14 +113,14 @@ Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c UpdateType: Immutable .PARAMETER MultiAZ - Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-multiaz PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Tags - Tags to be associated with the replication instance. + One or more tags to be assigned to the replication instance. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-tags @@ -304,16 +306,8 @@ Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c } })] $MultiAZ, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 index 9385ca467..6275a9785 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 @@ -31,7 +31,7 @@ Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. UpdateType: Immutable .PARAMETER SubnetIds - The EC2 subnet IDs for the subnet group. + One or more subnet IDs to be assigned to the subnet group. PrimitiveItemType: String Type: List @@ -39,7 +39,7 @@ Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. UpdateType: Mutable .PARAMETER Tags - The tag to be assigned to the subnet group. + One or more tags to be assigned to the subnet group. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-tags @@ -115,16 +115,8 @@ Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. $ReplicationSubnetGroupIdentifier, [parameter(Mandatory = $true)] $SubnetIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 index 333990c86..b9ff5e48d 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 @@ -32,6 +32,7 @@ The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” +When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition PrimitiveType: String @@ -244,16 +245,8 @@ Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ } })] $ReplicationInstanceArn, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 b/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 index 6f66a8546..fff47fb64 100644 --- a/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 @@ -35,7 +35,7 @@ After an alias has been created, it cannot be deleted or reused, so this operati UpdateType: Mutable .PARAMETER Name - The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable. + The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name PrimitiveType: String @@ -43,13 +43,14 @@ After an alias has been created, it cannot be deleted or reused, so this operati .PARAMETER Password The password for the default administrative user named Admin. +If you need to change the password for the administrator account, see the ResetUserPassword: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html API call in the *AWS Directory Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password PrimitiveType: String UpdateType: Immutable .PARAMETER ShortName - The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com. + The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 b/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 index 91f125917..ff995f735 100644 --- a/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 @@ -21,7 +21,7 @@ After an alias has been created, it cannot be deleted or reused, so this operati UpdateType: Immutable .PARAMETER Description - A textual description for the directory. + A description for the directory. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description PrimitiveType: String @@ -43,13 +43,14 @@ After an alias has been created, it cannot be deleted or reused, so this operati .PARAMETER Password The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password. +If you need to change the password for the administrator account, see the ResetUserPassword: https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html API call in the *AWS Directory Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password PrimitiveType: String UpdateType: Immutable .PARAMETER ShortName - The short name of the directory, such as CORP. + The NetBIOS name of the directory, such as CORP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 index a2bbe4183..1c201f821 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 @@ -13,7 +13,7 @@ function New-VSDocDBDBCluster { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER StorageEncrypted - Specifies whether the DB cluster is encrypted. + Specifies whether the cluster is encrypted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted PrimitiveType: Boolean @@ -27,20 +27,20 @@ function New-VSDocDBDBCluster { UpdateType: Immutable .PARAMETER KmsKeyId - The AWS KMS key identifier for an encrypted DB cluster. -The AWS KMS key identifier is the Amazon Resource Name ARN for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. + The AWS KMS key identifier for an encrypted cluster. +The AWS KMS key identifier is the Amazon Resource Name ARN for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. If an encryption key is not specified in KmsKeyId: + If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. + If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. -If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region. +If you create a replica of an encrypted cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZones - A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in. + A list of Amazon EC2 Availability Zones that instances in the cluster can be created in. PrimitiveItemType: String Type: List @@ -48,8 +48,8 @@ If you create a replica of an encrypted DB cluster in another AWS Region, you mu UpdateType: Immutable .PARAMETER SnapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from. -You can use either the name or the Amazon Resource Name ARN to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. + The identifier for the snapshot or cluster snapshot to restore from. +You can use either the name or the Amazon Resource Name ARN to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot. Constraints: + Must match the identifier of an existing snapshot. @@ -65,7 +65,7 @@ Constraints: UpdateType: Mutable .PARAMETER DBClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string. + The cluster identifier. This parameter is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + The first character must be a letter. @@ -88,7 +88,7 @@ Constraints: Minimum 30-minute window. UpdateType: Mutable .PARAMETER DBSubnetGroupName - A DB subnet group to associate with this DB cluster. + A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup @@ -111,14 +111,14 @@ Constraints: .PARAMETER MasterUserPassword The password for the master database user. This password can contain any printable ASCII character except forward slash /, double quote ", or the "at" symbol @. -Constraints: Must contain from 8 to 41 characters. +Constraints: Must contain from 8 to 100 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword PrimitiveType: String UpdateType: Mutable .PARAMETER VpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster. + A list of EC2 VPC security groups to associate with this cluster. PrimitiveItemType: String Type: List @@ -126,9 +126,9 @@ Constraints: Must contain from 8 to 41 characters. UpdateType: Mutable .PARAMETER MasterUsername - The name of the master user for the DB cluster. + The name of the master user for the cluster. Constraints: -+ Must be from 1 to 16 letters or numbers. ++ Must be from 1 to 63 letters or numbers. + The first character must be a letter. + Cannot be a reserved word for the chosen database engine. @@ -137,7 +137,7 @@ Constraints: UpdateType: Immutable .PARAMETER DBClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. + The name of the cluster parameter group to associate with this cluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname PrimitiveType: String @@ -154,7 +154,7 @@ Constraints: UpdateType: Mutable .PARAMETER Tags - The tags to be assigned to the DB cluster. + The tags to be assigned to the cluster. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags @@ -162,7 +162,7 @@ Constraints: UpdateType: Mutable .PARAMETER EnableCloudwatchLogsExports - + ModifyDBCluster: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html + A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. PrimitiveItemType: String Type: List @@ -363,16 +363,8 @@ Constraints: } })] $BackupRetentionPeriod, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $EnableCloudwatchLogsExports, diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 index 96e78859f..4a66b85ce 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 @@ -6,13 +6,13 @@ function New-VSDocDBDBClusterParameterGroup { .DESCRIPTION Adds an AWS::DocDB::DBClusterParameterGroup resource to the template. The AWS::DocDB::DBClusterParameterGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBClusterParameterGroup. For more information, see DBClusterParameterGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html in the *Amazon DocumentDB Developer Guide*. -Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. +Parameters in a cluster parameter group apply to all of the instances in a cluster. -A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover. +A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover. **Important** -After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. +After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html @@ -21,28 +21,28 @@ After you create a DB cluster parameter group, you should wait at least 5 minute The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description - The description for the DB cluster parameter group. + The description for the cluster parameter group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-description PrimitiveType: String UpdateType: Immutable .PARAMETER Parameters - Provides a list of parameters for the DB cluster parameter group. + Provides a list of parameters for the cluster parameter group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER Family - The DB cluster parameter group family name. + The cluster parameter group family name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-family PrimitiveType: String UpdateType: Immutable .PARAMETER Tags - The tags to be assigned to the DB cluster parameter group. + The tags to be assigned to the cluster parameter group. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-tags @@ -50,7 +50,7 @@ After you create a DB cluster parameter group, you should wait at least 5 minute UpdateType: Mutable .PARAMETER Name - The name of the DB cluster parameter group. + The name of the cluster parameter group. Constraints: + Must match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string. @@ -137,16 +137,8 @@ This value is stored as a lowercase string. } })] $Family, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 index c0d68df78..a7b59662c 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 @@ -13,21 +13,21 @@ function New-VSDocDBDBInstance { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBInstanceClass - The compute and memory capacity of the DB instance; for example, db.m4.large. If you change the class of an instance there can be some interruption in the cluster's service. + The compute and memory capacity of the instance; for example, db.m4.large. If you change the class of an instance there can be some interruption in the cluster's service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass PrimitiveType: String UpdateType: Mutable .PARAMETER DBClusterIdentifier - The identifier of the DB cluster that the instance will belong to. + The identifier of the cluster that the instance will belong to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier PrimitiveType: String UpdateType: Immutable .PARAMETER AvailabilityZone - The Amazon EC2 Availability Zone that the DB instance is created in. + The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint. @@ -48,7 +48,7 @@ Constraints: Minimum 30-minute window. UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade - Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. + Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window. Default: true Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade @@ -56,7 +56,7 @@ Default: true UpdateType: Mutable .PARAMETER DBInstanceIdentifier - The DB instance identifier. This parameter is stored as a lowercase string. + The instance identifier. This parameter is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + The first character must be a letter. @@ -68,7 +68,7 @@ Example: mydbinstance UpdateType: Immutable .PARAMETER Tags - The tags to be assigned to the DB instance. + The tags to be assigned to the instance. You can assign up to 10 tags to an instance. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags @@ -186,16 +186,8 @@ Example: mydbinstance } })] $DBInstanceIdentifier, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 index d617ea2c0..660fb0a09 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSDocDBDBSubnetGroup { <# .SYNOPSIS - Adds an AWS::DocDB::DBSubnetGroup resource to the template. The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBSubnetGroup. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see DBSubnetGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html in the *Amazon DocumentDB Developer Guide*. + Adds an AWS::DocDB::DBSubnetGroup resource to the template. The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBSubnetGroup. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see DBSubnetGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html in the *Amazon DocumentDB Developer Guide*. .DESCRIPTION - Adds an AWS::DocDB::DBSubnetGroup resource to the template. The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBSubnetGroup. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see DBSubnetGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html in the *Amazon DocumentDB Developer Guide*. + Adds an AWS::DocDB::DBSubnetGroup resource to the template. The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility resource describes a DBSubnetGroup. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see DBSubnetGroup: https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html in the *Amazon DocumentDB Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html @@ -13,7 +13,7 @@ function New-VSDocDBDBSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBSubnetGroupName - The name for the DB subnet group. This value is stored as a lowercase string. + The name for the subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup @@ -22,14 +22,14 @@ Example: mySubnetgroup UpdateType: Immutable .PARAMETER DBSubnetGroupDescription - The description for the DB subnet group. + The description for the subnet group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetIds - The Amazon EC2 subnet IDs for the DB subnet group. + The Amazon EC2 subnet IDs for the subnet group. PrimitiveItemType: String Type: List @@ -37,7 +37,7 @@ Example: mySubnetgroup UpdateType: Mutable .PARAMETER Tags - The tags to be assigned to the DB subnet group. + The tags to be assigned to the subnet group. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-tags @@ -113,16 +113,8 @@ Example: mySubnetgroup $DBSubnetGroupDescription, [parameter(Mandatory = $true)] $SubnetIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 b/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 index f8c4475e2..c41a9b0cc 100644 --- a/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 @@ -18,6 +18,7 @@ You should be aware of the following behaviors when working with DynamoDB tables .PARAMETER AttributeDefinitions A list of attributes that describe the key schema for the table and indexes. Duplicates are allowed. +This property is required to create a DynamoDB table. Update requires: Some interruptions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt. Replacement if you edit an existing AttributeDefinition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedef @@ -29,8 +30,8 @@ Update requires: Some interruptions: https://docs.aws.amazon.com/AWSCloudFormati .PARAMETER BillingMode Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: -+ PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. -+ PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. ++ PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual. ++ PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand. If not specified, the default is PROVISIONED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode @@ -244,16 +245,8 @@ For detailed information about the limits in DynamoDB, see Limits in Amazon Dyna } })] $TableName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $TimeToLiveSpecification, diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 index 68a245d57..1de90766e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 @@ -32,7 +32,9 @@ If you enable client connection logging, data about client connections is sent t UpdateType: Mutable .PARAMETER SplitTunnel - + Client VPN Endpoints: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html in the *AWS Client VPN Administrator Guide* + Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. +By default, split-tunnel on a VPN endpoint is disabled. +For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html in the *AWS Client VPN Administrator Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel PrimitiveType: Boolean @@ -69,7 +71,7 @@ If you enable client connection logging, data about client connections is sent t UpdateType: Mutable .PARAMETER DnsServers - Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server. + Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server. PrimitiveItemType: String Type: List @@ -85,7 +87,9 @@ Default value: udp UpdateType: Immutable .PARAMETER VpnPort - + Client VPN Endpoints: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html in the *AWS Client VPN Administrator Guide* + The port number to assign to the Client VPN endpoint for TCP and UDP traffic. +Valid Values: 443 | 1194 +Default Value: 443 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 index 93cc80358..0dc4bfe8b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 @@ -6,6 +6,8 @@ function New-VSEC2ClientVpnRoute { .DESCRIPTION Adds an AWS::EC2::ClientVpnRoute resource to the template. Specifies a network route to add to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. +A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html diff --git a/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 index 0988aada1..6feaeb831 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 @@ -110,16 +110,8 @@ Default: 65000 } })] $IpAddress, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 b/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 index fe15fe308..087052849 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 @@ -137,16 +137,8 @@ You must specify at least one of the following properties: DomainNameServers, Ne $NetbiosNodeType, [parameter(Mandatory = $false)] $NtpServers, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 index eddcea8ef..2e611aecf 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 @@ -13,14 +13,14 @@ function New-VSEC2EC2Fleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TargetCapacitySpecification - The TotalTargetCapacity, OnDemandTargetCapacity, SpotTargetCapacity, and DefaultCapacityType structure. + The number of units to request. Type: TargetCapacitySpecificationRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-targetcapacityspecification UpdateType: Mutable .PARAMETER OnDemandOptions - The allocation strategy of On-Demand Instances in an EC2 Fleet. + Describes the configuration of On-Demand Instances in an EC2 Fleet. Type: OnDemandOptionsRequest Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-ondemandoptions diff --git a/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 index e364322e5..3705a4571 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 @@ -32,6 +32,7 @@ Required when allocating an address to a VPC .PARAMETER InstanceId The ID of the instance. +Updates to the InstanceId property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid PrimitiveType: String @@ -39,12 +40,16 @@ Required when allocating an address to a VPC .PARAMETER PublicIpv4Pool The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. +Updates to the PublicIpv4Pool property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-publicipv4pool PrimitiveType: String UpdateType: Conditional .PARAMETER Tags + Any tags assigned to the Elastic IP address. +Updates to the Tags property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-tags DuplicatesAllowed: True ItemType: Tag @@ -129,16 +134,8 @@ Required when allocating an address to a VPC } })] $PublicIpv4Pool, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 b/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 index 0fe6ba58f..f30e65e80 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 @@ -22,7 +22,7 @@ If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn .PARAMETER LogDestination Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType. -If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name ARN of the CloudWatch Logs log group. +If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name ARN of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead. If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination diff --git a/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 index 5424b3849..583443e7a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2GatewayRouteTableAssociation { <# .SYNOPSIS - Adds an AWS::EC2::GatewayRouteTableAssociation resource to the template. + Adds an AWS::EC2::GatewayRouteTableAssociation resource to the template. Associates a virtual private gateway or internet gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table. .DESCRIPTION - Adds an AWS::EC2::GatewayRouteTableAssociation resource to the template. + Adds an AWS::EC2::GatewayRouteTableAssociation resource to the template. Associates a virtual private gateway or internet gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html @@ -13,11 +13,15 @@ function New-VSEC2GatewayRouteTableAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RouteTableId + The ID of the route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-routetableid UpdateType: Mutable PrimitiveType: String .PARAMETER GatewayId + The ID of the gateway. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-gatewayid UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 index e85a55ca2..9baca4869 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 @@ -36,7 +36,8 @@ Default: off UpdateType: Mutable .PARAMETER InstanceType - Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host. + Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. +If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify **InstanceFamily** instead. You cannot specify **InstanceType** and **InstanceFamily** in the same request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 index 985bc32cf..202a35442 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 @@ -31,6 +31,7 @@ If an Elastic IP address is attached to your instance, AWS CloudFormation reatta .PARAMETER AvailabilityZone The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. +This parameter is not supported by DescribeImageAttribute: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-availabilityzone PrimitiveType: String @@ -54,8 +55,8 @@ By default, the block devices specified in the block device mapping for the AMI UpdateType: Immutable .PARAMETER CreditSpecification - The credit option for CPU usage of the T2 or T3 instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html. For more information, see Burstable Performance Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html in the *Amazon Elastic Compute Cloud User Guide*. -Default: standard T2 instances or unlimited T3 instances + The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html. For more information, see Burstable Performance Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html in the *Amazon Elastic Compute Cloud User Guide*. +Default: standard T2 instances or unlimited T3/T3a instances Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-creditspecification Type: CreditSpecification @@ -96,7 +97,7 @@ Default: false UpdateType: Immutable .PARAMETER HibernationOptions - + EBS-Optimized Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#EBSOptimized in the *Amazon EC2 API Reference* + Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html in the *Amazon Elastic Compute Cloud User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hibernationoptions Type: HibernationOptions @@ -110,7 +111,8 @@ Default: false UpdateType: Conditional .PARAMETER HostResourceGroupArn - + EBS-Optimized Instances: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#EBSOptimized in the *Amazon EC2 API Reference* + The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the **Tenancy** parameter or set it to host. +This parameter is not supported by CreateFleet: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn PrimitiveType: String @@ -676,16 +678,8 @@ If you specify a network interface, you must specify any subnets as part of the } })] $SubnetId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 index f9dd548c2..679f711a5 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 @@ -66,16 +66,8 @@ function New-VSEC2InternetGateway { })] [System.String] $LogicalId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 index 0a7389b7b..dfd6bf1ca 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 @@ -1,10 +1,10 @@ function New-VSEC2LocalGatewayRoute { <# .SYNOPSIS - Adds an AWS::EC2::LocalGatewayRoute resource to the template. + Adds an AWS::EC2::LocalGatewayRoute resource to the template. Creates a static route for the specified local gateway route table. .DESCRIPTION - Adds an AWS::EC2::LocalGatewayRoute resource to the template. + Adds an AWS::EC2::LocalGatewayRoute resource to the template. Creates a static route for the specified local gateway route table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html @@ -13,16 +13,22 @@ function New-VSEC2LocalGatewayRoute { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DestinationCidrBlock + The CIDR block used for destination matches. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-destinationcidrblock UpdateType: Immutable PrimitiveType: String .PARAMETER LocalGatewayRouteTableId + The ID of the local gateway route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayroutetableid UpdateType: Immutable PrimitiveType: String .PARAMETER LocalGatewayVirtualInterfaceGroupId + The ID of the virtual interface group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 index f5cd15318..e689ad0a8 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2LocalGatewayRouteTableVPCAssociation { <# .SYNOPSIS - Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation resource to the template. + Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation resource to the template. Associates the specified VPC with the specified local gateway route table. .DESCRIPTION - Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation resource to the template. + Adds an AWS::EC2::LocalGatewayRouteTableVPCAssociation resource to the template. Associates the specified VPC with the specified local gateway route table. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html @@ -13,16 +13,22 @@ function New-VSEC2LocalGatewayRouteTableVPCAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LocalGatewayRouteTableId + The ID of the local gateway route table. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-localgatewayroutetableid UpdateType: Immutable PrimitiveType: String .PARAMETER VpcId + The ID of the VPC. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-vpcid UpdateType: Immutable PrimitiveType: String .PARAMETER Tags + The tags assigned to the association. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-tags UpdateType: Mutable Type: Tags diff --git a/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 index b1aa89bb4..af489c422 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 @@ -104,16 +104,8 @@ If you add a default route (AWS::EC2::Route resource that points to a NAT gatewa } })] $SubnetId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 index 916b4c247..65236721b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 @@ -73,16 +73,8 @@ function New-VSEC2NetworkAcl { })] [System.String] $LogicalId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 index e8447cd6f..da298851a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 @@ -6,6 +6,8 @@ function New-VSEC2NetworkAclEntry { .DESCRIPTION Adds an AWS::EC2::NetworkAclEntry resource to the template. Specifies an entry, known as a rule, in a network ACL with a rule number you specify. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. +For information about the protocol value, see Protocol Numbers: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml on the Internet Assigned Numbers Authority (IANA website. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 index 991cc3c3f..87a8cb3d0 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 @@ -29,7 +29,7 @@ function New-VSEC2NetworkInterface { UpdateType: Mutable .PARAMETER InterfaceType - The type of network interface. + Indicates the type of network interface. To create an Elastic Fabric Adapter EFA, specify efa. For more information, see Elastic Fabric Adapter: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html in the *Amazon Elastic Compute Cloud User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-interfacetype PrimitiveType: String @@ -233,16 +233,8 @@ The number of IP addresses you can assign to a network interface varies by insta } })] $SubnetId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 index e22844bf1..3f6762eeb 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 @@ -6,7 +6,7 @@ function New-VSEC2Route { .DESCRIPTION Adds an AWS::EC2::Route resource to the template. Specifies a route in a route table within a VPC. -You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. +You must specify one of the following targets: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, TransitGatewayId, or VpcPeeringConnectionId. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html @@ -38,8 +38,7 @@ You must specify the DestinationCidrBlock or DestinationIpv6CidrBlock property. UpdateType: Mutable .PARAMETER GatewayId - The ID of a gateway attached to your VPC. -You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. + The ID of an internet gateway or virtual private gateway attached to your VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid PrimitiveType: String @@ -47,7 +46,6 @@ You must specify only one of the following properties: EgressOnlyInternetGateway .PARAMETER InstanceId The ID of a NAT instance in your VPC. -You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid PrimitiveType: String @@ -55,7 +53,6 @@ You must specify only one of the following properties: EgressOnlyInternetGateway .PARAMETER NatGatewayId The ID of a NAT gateway. -You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid PrimitiveType: String @@ -63,7 +60,6 @@ You must specify only one of the following properties: EgressOnlyInternetGateway .PARAMETER NetworkInterfaceId The ID of the network interface. -You must specify only one of the following properties: EgressOnlyInternetGatewayId, GatewayId, InstanceId, NatGatewayId, NetworkInterfaceId, or VpcPeeringConnectionId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 b/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 index ec26884f0..ebf6e7159 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 @@ -75,16 +75,8 @@ For more information, see Route Tables: https://docs.aws.amazon.com/AmazonVPC/la })] [System.String] $LogicalId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 index 291c34b7a..bc2c19b63 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 @@ -1,10 +1,10 @@ function New-VSEC2SecurityGroup { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroup resource to the template. Specifies a security group. To create a VPC security group, use the VpcId: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid property. + Adds an AWS::EC2::SecurityGroup resource to the template. Specifies a security group. To create a security group, use the VpcId: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid property to specify the VPC for which to create the security group. .DESCRIPTION - Adds an AWS::EC2::SecurityGroup resource to the template. Specifies a security group. To create a VPC security group, use the VpcId: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid property. + Adds an AWS::EC2::SecurityGroup resource to the template. Specifies a security group. To create a security group, use the VpcId: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid property to specify the VPC for which to create the security group. This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html. @@ -161,16 +161,8 @@ Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=&;{}!$* } })] $SecurityGroupIngress, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 index a116b59a9..67e2f53ef 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 @@ -1,14 +1,16 @@ function New-VSEC2SecurityGroupIngress { <# .SYNOPSIS - Adds an AWS::EC2::SecurityGroupIngress resource to the template. Adds the specified ingress rules to a security group. + Adds an AWS::EC2::SecurityGroupIngress resource to the template. Adds an inbound rule to a security group. .DESCRIPTION - Adds an AWS::EC2::SecurityGroupIngress resource to the template. Adds the specified ingress rules to a security group. + Adds an AWS::EC2::SecurityGroupIngress resource to the template. Adds an inbound rule to a security group. -An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from the specified destination security groups. +An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances associated with the specified security group. -You specify a protocol for each rule (for example, TCP. For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. +You specify a protocol for each rule (for example, TCP. For TCP and UDP, you must also specify a port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. + +You must specify a source security group (SourcePrefixListId, SourceSecurityGroupId, or SourceSecurityGroupName or a CIDR range (CidrIp or CidrIpv6. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. @@ -49,7 +51,7 @@ Use this for ICMP and any protocol that uses ports. .PARAMETER GroupId The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. -You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. For example, EC2-VPC: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html accounts must use the GroupId property. +You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupid PrimitiveType: String @@ -75,30 +77,28 @@ VPC only] Use -1 to specify all protocols. When authorizing security group rules .PARAMETER SourcePrefixListId EC2-VPC only] The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. -You must specify a source security group SourcePrefixListId, SourceSecurityGroupId, or SourceSecurityGroupName or a CIDR range CidrIp or CidrIpv6. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid PrimitiveType: String UpdateType: Immutable .PARAMETER SourceSecurityGroupId - The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. -If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. + The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupid PrimitiveType: String UpdateType: Immutable .PARAMETER SourceSecurityGroupName - EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC. -You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. For example, EC2-VPC: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html accounts must use the GroupId property. + EC2-Classic, default VPC] The name of the source security group. +You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupname PrimitiveType: String UpdateType: Immutable .PARAMETER SourceSecurityGroupOwnerId - nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. + nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupownerid diff --git a/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 index a651af5f6..30a373f40 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 @@ -18,8 +18,8 @@ If you've associated an IPv6 CIDR block with your VPC, you can create a subnet w .PARAMETER AssignIpv6AddressOnCreation Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false. -If you specify a true or false value for AssignIpv6AddressOnCreation, Ipv6CidrBlock must also be specified. -If AssignIpv6AddressOnCreation is specified, MapPublicIpOnLaunch cannot be specified. +If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock. +If you specify AssignIpv6AddressOnCreation, you cannot specify MapPublicIpOnLaunch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation PrimitiveType: Boolean @@ -43,7 +43,7 @@ If you update this property, you must also update the AvailabilityZone property. .PARAMETER Ipv6CidrBlock The IPv6 CIDR block. -If you specify a true or false value for AssignIpv6AddressOnCreation, Ipv6CidrBlock must be specified. +If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock PrimitiveType: String @@ -51,7 +51,7 @@ If you specify a true or false value for AssignIpv6AddressOnCreation, Ipv6CidrBl .PARAMETER MapPublicIpOnLaunch Indicates whether instances launched in this subnet receive a public IPv4 address. -If MapPublicIpOnLaunch is specified. AssignIpv6AddressOnCreation cannot be specified. +If you specify MapPublicIpOnLaunch, you cannot specify AssignIpv6AddressOnCreation. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch PrimitiveType: Boolean @@ -174,16 +174,8 @@ If you update this property, you must also update the CidrBlock property. } })] $MapPublicIpOnLaunch, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 index ad10cc03c..5791ec93d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSEC2SubnetRouteTableAssociation { <# .SYNOPSIS - Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. + Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. If you want to associate a route table with a VPC, see AWS::EC2::RouteTable: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html. .DESCRIPTION - Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. + Adds an AWS::EC2::SubnetRouteTableAssociation resource to the template. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. If you want to associate a route table with a VPC, see AWS::EC2::RouteTable: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 index e2625bbdf..7f28da003 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 @@ -1,10 +1,14 @@ function New-VSEC2TrafficMirrorFilter { <# .SYNOPSIS - Adds an AWS::EC2::TrafficMirrorFilter resource to the template. + Adds an AWS::EC2::TrafficMirrorFilter resource to the template. Specifies a Traffic Mirror filter. .DESCRIPTION - Adds an AWS::EC2::TrafficMirrorFilter resource to the template. + Adds an AWS::EC2::TrafficMirrorFilter resource to the template. Specifies a Traffic Mirror filter. + +A Traffic Mirror filter is a set of rules that defines the traffic to mirror. + +By default, no traffic is mirrored. To mirror traffic, use AWS::EC2::TrafficMirrorFilterRule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html @@ -13,17 +17,24 @@ function New-VSEC2TrafficMirrorFilter { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + The description of the Traffic Mirror filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-description PrimitiveType: String UpdateType: Immutable .PARAMETER NetworkServices + The network service traffic that is associated with the Traffic Mirror filter. +Valid values are amazon-dns. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-networkservices UpdateType: Mutable .PARAMETER Tags + The tags to assign to a Traffic Mirror filter. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-tags ItemType: Tag @@ -87,16 +98,8 @@ function New-VSEC2TrafficMirrorFilter { $Description, [parameter(Mandatory = $false)] $NetworkServices, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 index c69b9d9d0..7dc3aa3dc 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 @@ -1,10 +1,14 @@ function New-VSEC2TrafficMirrorFilterRule { <# .SYNOPSIS - Adds an AWS::EC2::TrafficMirrorFilterRule resource to the template. + Adds an AWS::EC2::TrafficMirrorFilterRule resource to the template. Creates a Traffic Mirror filter rule. .DESCRIPTION - Adds an AWS::EC2::TrafficMirrorFilterRule resource to the template. + Adds an AWS::EC2::TrafficMirrorFilterRule resource to the template. Creates a Traffic Mirror filter rule. + +A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror. + +You need the Traffic Mirror filter ID when you create the rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html @@ -13,51 +17,72 @@ function New-VSEC2TrafficMirrorFilterRule { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DestinationPortRange + The destination port range. + Type: TrafficMirrorPortRange Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationportrange UpdateType: Mutable .PARAMETER Description + The description of the Traffic Mirror rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-description PrimitiveType: String UpdateType: Mutable .PARAMETER SourcePortRange + The source port range. + Type: TrafficMirrorPortRange Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourceportrange UpdateType: Mutable .PARAMETER RuleAction + The action to take accept | reject on the filtered traffic. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-ruleaction PrimitiveType: String UpdateType: Mutable .PARAMETER SourceCidrBlock + The source CIDR block to assign to the Traffic Mirror rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourcecidrblock PrimitiveType: String UpdateType: Mutable .PARAMETER RuleNumber + The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-rulenumber PrimitiveType: Integer UpdateType: Mutable .PARAMETER DestinationCidrBlock + The destination CIDR block to assign to the Traffic Mirror rule. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationcidrblock PrimitiveType: String UpdateType: Mutable .PARAMETER TrafficMirrorFilterId + The ID of the filter that this rule is associated with. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorfilterid PrimitiveType: String UpdateType: Immutable .PARAMETER TrafficDirection + The type of traffic ingress | egress. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficdirection PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol + The protocol, for example UDP, to assign to the Traffic Mirror rule. +For information about the protocol value, see Protocol Numbers: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml on the Internet Assigned Numbers Authority IANA website. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-protocol PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 index 83ca9bead..0a5e5aa9d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 @@ -1,10 +1,16 @@ function New-VSEC2TrafficMirrorSession { <# .SYNOPSIS - Adds an AWS::EC2::TrafficMirrorSession resource to the template. + Adds an AWS::EC2::TrafficMirrorSession resource to the template. Creates a Traffic Mirror session. .DESCRIPTION - Adds an AWS::EC2::TrafficMirrorSession resource to the template. + Adds an AWS::EC2::TrafficMirrorSession resource to the template. Creates a Traffic Mirror session. + +A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic. + +The Traffic Mirror source and the Traffic Mirror target (monitoring appliances can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway. + +By default, no traffic is mirrored. Use AWS::EC2::TrafficMirrorFilterRule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html to specify filter rules that specify the traffic to mirror. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html @@ -13,41 +19,59 @@ function New-VSEC2TrafficMirrorSession { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TrafficMirrorTargetId + The ID of the Traffic Mirror target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The description of the Traffic Mirror session. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description PrimitiveType: String UpdateType: Mutable .PARAMETER SessionNumber + The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. +Valid values are 1-32766. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber PrimitiveType: Integer UpdateType: Mutable .PARAMETER VirtualNetworkId + The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348: https://tools.ietf.org/html/rfc7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid PrimitiveType: Integer UpdateType: Mutable .PARAMETER PacketLength + The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length in bytes that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. +If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength PrimitiveType: Integer UpdateType: Mutable .PARAMETER NetworkInterfaceId + The ID of the source network interface. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid PrimitiveType: String UpdateType: Immutable .PARAMETER TrafficMirrorFilterId + The ID of the Traffic Mirror filter. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + The tags to assign to a Traffic Mirror session. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags ItemType: Tag @@ -175,16 +199,8 @@ function New-VSEC2TrafficMirrorSession { } })] $TrafficMirrorFilterId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 index 37b54c0b1..3132c6192 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 @@ -1,10 +1,16 @@ function New-VSEC2TrafficMirrorTarget { <# .SYNOPSIS - Adds an AWS::EC2::TrafficMirrorTarget resource to the template. + Adds an AWS::EC2::TrafficMirrorTarget resource to the template. Specifies a target for your Traffic Mirror session. .DESCRIPTION - Adds an AWS::EC2::TrafficMirrorTarget resource to the template. + Adds an AWS::EC2::TrafficMirrorTarget resource to the template. Specifies a target for your Traffic Mirror session. + +A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway. + +A Traffic Mirror target can be a network interface, or a Network Load Balancer. + +To use the target in a Traffic Mirror session, use AWS::EC2::TrafficMirrorSession: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html @@ -13,21 +19,29 @@ function New-VSEC2TrafficMirrorTarget { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER NetworkLoadBalancerArn + The Amazon Resource Name ARN of the Network Load Balancer that is associated with the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkloadbalancerarn PrimitiveType: String UpdateType: Immutable .PARAMETER Description + The description of the Traffic Mirror target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-description PrimitiveType: String UpdateType: Immutable .PARAMETER NetworkInterfaceId + The network interface ID that is associated with the target. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkinterfaceid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + The tags to assign to the Traffic Mirror target. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-tags ItemType: Tag @@ -111,16 +125,8 @@ function New-VSEC2TrafficMirrorTarget { } })] $NetworkInterfaceId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 index 676f952eb..adc64dcf6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 @@ -63,7 +63,7 @@ When you create a transit gateway, we create a default transit gateway route tab UpdateType: Immutable .PARAMETER AmazonSideAsn - A private Autonomous System Number ASN for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. + A private Autonomous System Number ASN for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-amazonsideasn PrimitiveType: Integer @@ -199,16 +199,8 @@ When you create a transit gateway, we create a default transit gateway route tab } })] $AmazonSideAsn, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 index 0c91bd4e5..f3178dfe8 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 @@ -115,16 +115,8 @@ To send VPC traffic to an attached transit gateway, add a route to the VPC route $VpcId, [parameter(Mandatory = $true)] $SubnetIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 index 332ec18db..8e1264f91 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 @@ -83,16 +83,8 @@ function New-VSEC2TransitGatewayRouteTable { } })] $TransitGatewayId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 index 1924dba3e..019f99f97 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 @@ -6,6 +6,10 @@ function New-VSEC2TransitGatewayRouteTableAssociation { .DESCRIPTION Adds an AWS::EC2::TransitGatewayRouteTableAssociation resource to the template. Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. +**Note** + +The TransitGatewayRouteTableId value changes when you use AWS::EC2::TransitGatewayRouteTableAssociation. To update the route table on the resource, detach the route table and update the Cloud Formation stack. After you have the new TransitGatewayRouteTableId, perform another Cloud Formation stack update with the new ID. For more information, see Update Behaviors of Stack Resources: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 index 83ed275aa..847d07b12 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 @@ -20,7 +20,7 @@ function New-VSEC2VPC { UpdateType: Immutable .PARAMETER EnableDnsHostnames - Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. + Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see DNS Support in Your VPC: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support. You can only enable DNS hostnames if you've enabled DNS support. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsHostnames @@ -28,7 +28,7 @@ You can only enable DNS hostnames if you've enabled DNS support. UpdateType: Mutable .PARAMETER EnableDnsSupport - Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. + Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see DNS Support in Your VPC: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsSupport PrimitiveType: Boolean @@ -36,8 +36,8 @@ You can only enable DNS hostnames if you've enabled DNS support. .PARAMETER InstanceTenancy The allowed tenancy of instances launched into the VPC. -+ "default": Instances can be launched with any tenancy. -+ "dedicated": Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy. ++ "default": An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. ++ "dedicated": An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch. Updating InstanceTenancy requires no replacement only if you are updating its value from "dedicated" to "default". Updating InstanceTenancy from "default" to "dedicated" requires replacement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-instancetenancy @@ -142,16 +142,8 @@ Updating InstanceTenancy requires no replacement only if you are updating its va } })] $InstanceTenancy, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 index 27546df0a..5af444b5e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 @@ -1,10 +1,10 @@ function New-VSEC2VPCCidrBlock { <# .SYNOPSIS - Adds an AWS::EC2::VPCCidrBlock resource to the template. Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. An IPv6 CIDR block must have a prefix length of /64. + Adds an AWS::EC2::VPCCidrBlock resource to the template. Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. The IPv6 CIDR block size is fixed at /56. .DESCRIPTION - Adds an AWS::EC2::VPCCidrBlock resource to the template. Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. An IPv6 CIDR block must have a prefix length of /64. + Adds an AWS::EC2::VPCCidrBlock resource to the template. Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. The IPv6 CIDR block size is fixed at /56. For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing in the *Amazon Virtual Private Cloud User Guide*. diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 index e09a6e661..7e014ca48 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 @@ -26,7 +26,7 @@ An interface endpoint is a network interface in your subnet that serves as an en .PARAMETER PrivateDnsEnabled Interface endpoint Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region for example, kinesis.us-east-1.amazonaws.com which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. -Default: true +Default: false Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled PrimitiveType: Boolean @@ -43,6 +43,7 @@ Default: true .PARAMETER SecurityGroupIds Interface endpoint The ID of one or more security groups to associate with the endpoint network interface. +This field is required when the endpoint is an interface. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids DuplicatesAllowed: False @@ -59,6 +60,7 @@ Default: true .PARAMETER SubnetIds Interface endpoint The ID of one or more subnets in which to create an endpoint network interface. +This field is required when the endpoint is an interface. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids DuplicatesAllowed: False @@ -76,6 +78,7 @@ Default: Gateway .PARAMETER VpcId The ID of the VPC in which the endpoint will be used. +This field is required when the endpoint is an interface. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 index 764f5483b..7a94470e3 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 @@ -1,10 +1,10 @@ function New-VSEC2VPCGatewayAttachment { <# .SYNOPSIS - Adds an AWS::EC2::VPCGatewayAttachment resource to the template. Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. + Adds an AWS::EC2::VPCGatewayAttachment resource to the template. Attaches an internet gateway, or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. .DESCRIPTION - Adds an AWS::EC2::VPCGatewayAttachment resource to the template. Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. + Adds an AWS::EC2::VPCGatewayAttachment resource to the template. Attaches an internet gateway, or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 index 521bc34dd..0391d4a9e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 @@ -38,6 +38,7 @@ Default: The Region in which you make the request. .PARAMETER PeerRoleArn The Amazon Resource Name ARN of the VPC peer role for the peering connection in another AWS account. +This is required when you are peering a VPC in a different AWS account. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn PrimitiveType: String @@ -155,16 +156,8 @@ Default: The Region in which you make the request. } })] $PeerVpcId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 index 6dece4130..dac47e54b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 @@ -1,10 +1,14 @@ function New-VSEC2VPNConnection { <# .SYNOPSIS - Adds an AWS::EC2::VPNConnection resource to the template. Specifies a VPN connection between a virtual private gateway and a VPN customer gateway. + Adds an AWS::EC2::VPNConnection resource to the template. Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway. .DESCRIPTION - Adds an AWS::EC2::VPNConnection resource to the template. Specifies a VPN connection between a virtual private gateway and a VPN customer gateway. + Adds an AWS::EC2::VPNConnection resource to the template. Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway. + +To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties. + +To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties. For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html in the *AWS Site-to-Site VPN User Guide*. @@ -62,7 +66,7 @@ You must specify either TransitGatewayId or VpnGatewayId, but not both. UpdateType: Immutable .PARAMETER VpnTunnelOptionsSpecifications - The tunnel options for a VPN connection. + The tunnel options for the VPN connection. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications DuplicatesAllowed: False @@ -137,16 +141,8 @@ You must specify either TransitGatewayId or VpnGatewayId, but not both. } })] $StaticRoutesOnly, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 index bc4ebc783..0e14ea361 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 @@ -84,16 +84,8 @@ For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/ $LogicalId, [parameter(Mandatory = $false)] $AmazonSideAsn, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 index ed094d8ac..ccef192c6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 @@ -76,18 +76,16 @@ AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias UpdateType: Mutable .PARAMETER Size - The size of the volume, in GiBs. + The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. -At least one of Size or SnapshotId is required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-size PrimitiveType: Integer UpdateType: Mutable .PARAMETER SnapshotId - The snapshot from which to create the volume. -At least one of Size or SnapshotId are required. + The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-snapshotid PrimitiveType: String @@ -104,7 +102,7 @@ At least one of Size or SnapshotId are required. .PARAMETER VolumeType The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes. -Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2. +Default: gp2 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-volumetype PrimitiveType: String @@ -232,16 +230,8 @@ Defaults: If no volume type is specified, the default is standard in us-east-1, } })] $SnapshotId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 index 26ab0b810..ba3bbe7eb 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 @@ -26,14 +26,14 @@ If the root volume is detached from an instance with an AWS Marketplace product UpdateType: Immutable .PARAMETER InstanceId - The ID of the instance to which the volume attaches. This value can be a reference to an AWS::EC2::Instance resource, or it can be the physical ID of an existing EC2 instance. + The ID of the instance to which the volume attaches. This value can be a reference to an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html resource, or it can be the physical ID of an existing EC2 instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-instanceid PrimitiveType: String UpdateType: Immutable .PARAMETER VolumeId - The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an AWS::EC2::Volume resource, or it can be the volume ID of an existing Amazon EBS volume. + The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html resource, or it can be the volume ID of an existing Amazon EBS volume. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-volumeid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 b/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 index 104b857d9..95978a5c0 100644 --- a/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 @@ -13,7 +13,7 @@ function New-VSECRRepository { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER LifecyclePolicy - Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html. + Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy Type: LifecyclePolicy @@ -112,16 +112,8 @@ If you specify a name, you cannot perform updates that require replacement of th } })] $RepositoryPolicyText, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 b/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 index f531625b8..298112482 100644 --- a/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 @@ -20,6 +20,8 @@ function New-VSECSCluster { UpdateType: Immutable .PARAMETER ClusterSettings + The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html or PutAccountSettingDefault: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustersettings DuplicatesAllowed: False ItemType: ClusterSetting @@ -27,6 +29,16 @@ function New-VSECSCluster { UpdateType: Mutable .PARAMETER Tags + The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. +The following basic restrictions apply to tags: ++ Maximum number of tags per resource - 50 ++ For each resource, each tag key must be unique, and each tag key can have only one value. ++ Maximum key length - 128 Unicode characters in UTF-8 ++ Maximum value length - 256 Unicode characters in UTF-8 ++ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. ++ Tag keys and values are case-sensitive. ++ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-tags DuplicatesAllowed: True ItemType: Tag @@ -100,16 +112,8 @@ function New-VSECSCluster { } })] $ClusterSettings, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 b/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 index 2811df2f1..03c2bf218 100644 --- a/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 @@ -1,10 +1,10 @@ function New-VSECSPrimaryTaskSet { <# .SYNOPSIS - Adds an AWS::ECS::PrimaryTaskSet resource to the template. + Adds an AWS::ECS::PrimaryTaskSet resource to the template. Specifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION - Adds an AWS::ECS::PrimaryTaskSet resource to the template. + Adds an AWS::ECS::PrimaryTaskSet resource to the template. Specifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html @@ -13,16 +13,22 @@ function New-VSECSPrimaryTaskSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Cluster + The short name or full Amazon Resource Name ARN of the cluster that hosts the service that the task set exists in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-cluster UpdateType: Immutable PrimitiveType: String .PARAMETER TaskSetId + The short name or full Amazon Resource Name ARN of the task set to set as the primary task set in the deployment. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-tasksetid UpdateType: Mutable PrimitiveType: String .PARAMETER Service + The short name or full Amazon Resource Name ARN of the service that the task set exists in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-service UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSECSService.ps1 b/VaporShell/Public/Resource Types/New-VSECSService.ps1 index 1bd7d2148..dae2b857a 100644 --- a/VaporShell/Public/Resource Types/New-VSECSService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSService.ps1 @@ -27,24 +27,30 @@ function New-VSECSService { UpdateType: Mutable .PARAMETER DeploymentController + The deployment controller to use for the service. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentcontroller Type: DeploymentController UpdateType: Immutable .PARAMETER DesiredCount The number of instantiations of the specified task definition to place and keep running on your cluster. +This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER EnableECSManagedTags + Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html in the *Amazon Elastic Container Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableecsmanagedtags PrimitiveType: Boolean UpdateType: Immutable .PARAMETER HealthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. + The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used. +If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds PrimitiveType: Integer @@ -99,13 +105,15 @@ function New-VSECSService { UpdateType: Immutable .PARAMETER PropagateTags + Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html API action. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-propagatetags PrimitiveType: String UpdateType: Immutable .PARAMETER Role The name or full Amazon Resource Name ARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. -If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html in the *Amazon Elastic Container Service Developer Guide*. +If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than /, then you must either specify the full role ARN this is recommended or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names in the *IAM User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role @@ -142,6 +150,16 @@ Service discovery is supported for Fargate tasks if you are using platform versi UpdateType: Immutable .PARAMETER Tags + The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. +The following basic restrictions apply to tags: ++ Maximum number of tags per resource - 50 ++ For each resource, each tag key must be unique, and each tag key can have only one value. ++ Maximum key length - 128 Unicode characters in UTF-8 ++ Maximum value length - 256 Unicode characters in UTF-8 ++ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. ++ Tag keys and values are case-sensitive. ++ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-tags DuplicatesAllowed: True ItemType: Tag @@ -149,7 +167,7 @@ Service discovery is supported for Fargate tasks if you are using platform versi UpdateType: Mutable .PARAMETER TaskDefinition - The family and revision family:revision or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. + The family and revision family:revision or full ARN of the task definition to run in your service. The revision is required in order for the resource to stabilize. A task definition must be specified if the service is using the ECS deployment controller. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition @@ -361,16 +379,8 @@ A task definition must be specified if the service is using the ECS deployment c } })] $ServiceRegistries, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 index d4976c473..42f0b9742 100644 --- a/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 @@ -34,7 +34,8 @@ function New-VSECSTaskDefinition { UpdateType: Immutable .PARAMETER Family - The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. + The name of a family that this task definition is registered to. Up to 255 letters uppercase and lowercase, numbers, hyphens, and underscores are allowed. +A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family @@ -42,6 +43,8 @@ To use revision numbers when you update a task definition, specify this property UpdateType: Immutable .PARAMETER InferenceAccelerators + The Elastic Inference accelerators to use for the containers in the task. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-inferenceaccelerators DuplicatesAllowed: False ItemType: InferenceAccelerator @@ -82,7 +85,7 @@ For more information, see Network settings: https://docs.docker.com/engine/refer UpdateType: Immutable .PARAMETER PidMode - The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings: https://docs.docker.com/engine/reference/run/#pid-settings---pid in the *Docker run reference*. + The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings: https://docs.docker.com/engine/reference/run/#pid-settings---pid in the *Docker run reference*. If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security: https://docs.docker.com/engine/security/security/. This parameter is not supported for Windows containers or tasks using the Fargate launch type. @@ -311,16 +314,8 @@ For more information about volume definition parameters and defaults, see Amazon $ProxyConfiguration, [parameter(Mandatory = $false)] $RequiresCompatibilities, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 b/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 index 9a3ee0afb..2a5baf4f1 100644 --- a/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 @@ -1,10 +1,10 @@ function New-VSECSTaskSet { <# .SYNOPSIS - Adds an AWS::ECS::TaskSet resource to the template. + Adds an AWS::ECS::TaskSet resource to the template. Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION - Adds an AWS::ECS::TaskSet resource to the template. + Adds an AWS::ECS::TaskSet resource to the template. Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html @@ -13,53 +13,74 @@ function New-VSECSTaskSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Cluster + The short name or full Amazon Resource Name ARN of the cluster that hosts the service to create the task set in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster UpdateType: Immutable PrimitiveType: String .PARAMETER ExternalId + An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid UpdateType: Immutable PrimitiveType: String .PARAMETER LaunchType + The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the *Amazon Elastic Container Service Developer Guide*. +If a launchType is specified, the capacityProviderStrategy parameter must be omitted. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype UpdateType: Immutable PrimitiveType: String .PARAMETER LoadBalancers + A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers UpdateType: Immutable Type: List ItemType: LoadBalancer .PARAMETER NetworkConfiguration + The network configuration for the task set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration UpdateType: Immutable Type: NetworkConfiguration .PARAMETER PlatformVersion + The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion UpdateType: Immutable PrimitiveType: String .PARAMETER Scale + A floating-point percentage of the desired number of tasks to place and keep running in the task set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale UpdateType: Mutable Type: Scale .PARAMETER Service + The short name or full Amazon Resource Name ARN of the service to create the task set in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service UpdateType: Immutable PrimitiveType: String .PARAMETER ServiceRegistries + The details of the service discovery registries to assign to this task set. For more information, see Service Discovery: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries UpdateType: Immutable Type: List ItemType: ServiceRegistry .PARAMETER TaskDefinition + The task definition for the tasks in the task set to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition UpdateType: Immutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 b/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 index e3decedfe..126751b37 100644 --- a/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 @@ -34,7 +34,7 @@ function New-VSEFSFileSystem { UpdateType: Immutable .PARAMETER LifecyclePolicies - + Creating an Amazon Elastic File System: https://docs.aws.amazon.com/efs/latest/ug/creating-using-fs.html + A list of policies used by EFS lifecycle management to transition files to the Infrequent Access IA storage class. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-elasticfilesystem-filesystem-lifecyclepolicies DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 b/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 index 4442623fa..2a04df1f6 100644 --- a/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 @@ -1,10 +1,14 @@ function New-VSEKSNodegroup { <# .SYNOPSIS - Adds an AWS::EKS::Nodegroup resource to the template. + Adds an AWS::EKS::Nodegroup resource to the template. Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster. .DESCRIPTION - Adds an AWS::EKS::Nodegroup resource to the template. + Adds an AWS::EKS::Nodegroup resource to the template. Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster. + +An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS-optimized Amazon Linux 2 AMI. + +You can only create a managed node group for Amazon EKS clusters that support managed nodes. For more information, see Managed Node Groups: https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html in the *Amazon EKS User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html @@ -13,73 +17,102 @@ function New-VSEKSNodegroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ScalingConfig + The scaling configuration details for the Auto Scaling group that is created for your node group. + Type: ScalingConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-scalingconfig UpdateType: Mutable .PARAMETER Labels + The Kubernetes labels to be applied to the nodes in the node group when they are created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-labels PrimitiveType: Json UpdateType: Mutable .PARAMETER ReleaseVersion + The AMI version of the Amazon EKS-optimized AMI to use with your node group for example, 1.14.7-YYYYMMDD. By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html in the *Amazon EKS User Guide*. +Changing this value triggers an update of the node group if one is available. However, only the latest available AMI release version is valid as an input. You cannot roll back to a previous AMI release version. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-releaseversion PrimitiveType: String UpdateType: Mutable .PARAMETER NodegroupName + The unique name to give your node group. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-nodegroupname PrimitiveType: String UpdateType: Immutable .PARAMETER Subnets + The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-subnets UpdateType: Immutable .PARAMETER NodeRole + The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role: https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html in the * *Amazon EKS User Guide* *. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-noderole PrimitiveType: String UpdateType: Immutable .PARAMETER AmiType + The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-amitype PrimitiveType: String UpdateType: Immutable .PARAMETER ForceUpdateEnabled + Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-forceupdateenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Version + The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-version PrimitiveType: String UpdateType: Mutable .PARAMETER RemoteAccess + The remote access SSH configuration to use with your node group. + Type: RemoteAccess Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-remoteaccess UpdateType: Immutable .PARAMETER DiskSize + The root device disk size in GiB for your node group instances. The default disk size is 20 GiB. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-disksize PrimitiveType: Double UpdateType: Immutable .PARAMETER ClusterName + The name of the cluster to create the node group in. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-clustername PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceTypes + The instance type to use for your node group. Currently, you can specify a single instance type for a node group. The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to specify the AL2_x86_64_GPU with the amiType parameter. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes UpdateType: Immutable .PARAMETER Tags + The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 b/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 index b5fbc7475..317d3b1e8 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 @@ -103,7 +103,7 @@ function New-VSEMRCluster { UpdateType: Immutable .PARAMETER ReleaseLabel - The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version, for example, emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use AmiVersion. + The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-releaselabel PrimitiveType: String @@ -149,7 +149,8 @@ function New-VSEMRCluster { UpdateType: Mutable .PARAMETER VisibleToAllUsers - Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action. + Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action. +When you create clusters directly through the EMR console or API, this value is set to true by default. However, for AWS::EMR::Cluster resources in CloudFormation, the default is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-visibletoallusers PrimitiveType: Boolean @@ -369,16 +370,8 @@ function New-VSEMRCluster { } })] $Steps, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 b/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 index da3726a05..58d5f2558 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 @@ -20,8 +20,7 @@ function New-VSEMRInstanceGroupConfig { UpdateType: Mutable .PARAMETER BidPrice - The maximum Spot price your are willing to pay for EC2 instances. -If BidPrice is specified, Amazon EMR uses Spot Instances for the instance group. Specified in USD. Alternatively, a value of OnDemandPrice indicates that the maximum Spot price is set equal to the On-Demand price. + The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-bidprice PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 b/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 index e3e80e8c0..2be79670b 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 @@ -13,7 +13,7 @@ function New-VSEMRStep { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ActionOnFailure - The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + This specifies what action to take when the cluster step fails. Possible values are CANCEL_AND_WAIT and CONTINUE. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-actiononfailure PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 index eeb1c9423..b1431a533 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 @@ -457,16 +457,8 @@ Use this parameter only when you are creating a cluster in an Amazon Virtual Pri } })] $SnapshotWindow, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $VpcSecurityGroupIds, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 index bb191aca1..ba9b5cfaa 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 @@ -29,7 +29,7 @@ For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an Auth Password constraints: + Must be only printable ASCII characters. + Must be at least 16 characters and no more than 128 characters in length. -+ Cannot contain any of the following characters: '/', '"', or '@'. ++ The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password: http://redis.io/commands/AUTH at http://redis.io/commands/AUTH. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken @@ -136,6 +136,7 @@ If you're going to launch your cluster in an Amazon VPC, you need to create a su .PARAMETER NodeGroupConfiguration NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache ElastiCache Redis cluster node group. +If you set UseOnlineResharding: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding to true, you can update NodeGroupConfiguration without interruption. When UseOnlineResharding is set to false, or is not specified, updating NodeGroupConfiguration results in replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration DuplicatesAllowed: False @@ -163,6 +164,7 @@ The maximum permitted value for NumCacheClusters is 6 1 primary plus 5 replicas. .PARAMETER NumNodeGroups An optional parameter that specifies the number of node groups shards for this Redis cluster mode enabled replication group. For Redis cluster mode disabled either omit this parameter or set it to 1. +If you set UseOnlineResharding: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding to true, you can update NumNodeGroups without interruption. When UseOnlineResharding is set to false, or is not specified, updating NumNodeGroups results in replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement. Default: 1 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups @@ -629,16 +631,8 @@ For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an Auth } })] $SnapshottingClusterId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 index a6ec87a9a..dc1a5d3bc 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 @@ -6,6 +6,10 @@ function New-VSElasticBeanstalkConfigurationTemplate { .DESCRIPTION Adds an AWS::ElasticBeanstalk::ConfigurationTemplate resource to the template. The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. +**Note** + +The Elastic Beanstalk console and documentation often refer to configuration templates as *saved configurations*. When you set configuration options in a saved configuration (configuration template, Elastic Beanstalk applies them with a particular precedence as part of applying options from multiple sources. For more information, see Configuration Options: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html in the *AWS Elastic Beanstalk Developer Guide*. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 index 76a7a41ee..792f2ca56 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 @@ -223,16 +223,8 @@ Default: If not specified, Elastic Beanstalk attempts to deploy the sample appli } })] $SolutionStackName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 index 907c25479..4ba9002e7 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 @@ -294,16 +294,8 @@ Update requires replacement if you did not previously specify a subnet or if you $SecurityGroups, [parameter(Mandatory = $false)] $Subnets, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 index 62b255a49..7c99a5d3b 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 @@ -14,6 +14,7 @@ function New-VSElasticLoadBalancingV2Listener { .PARAMETER Certificates The default SSL server certificate. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. +To create a certificate list for the listener, use AWS::ElasticLoadBalancingV2::ListenerCertificate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates DuplicatesAllowed: False @@ -45,14 +46,24 @@ function New-VSElasticLoadBalancingV2Listener { UpdateType: Mutable .PARAMETER Protocol - The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. + The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER SslPolicy - HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy. + HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values: ++ ELBSecurityPolicy-2016-08 ++ ELBSecurityPolicy-TLS-1-0-2015-04 ++ ELBSecurityPolicy-TLS-1-1-2017-01 ++ ELBSecurityPolicy-TLS-1-2-2017-01 ++ ELBSecurityPolicy-TLS-1-2-Ext-2018-06 ++ ELBSecurityPolicy-FS-2018-06 ++ ELBSecurityPolicy-FS-1-1-2019-08 ++ ELBSecurityPolicy-FS-1-2-2019-08 ++ ELBSecurityPolicy-FS-1-2-Res-2019-08 +For more information, see Security Policies: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies in the *Application Load Balancers Guide* and Security Policies: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies in the *Network Load Balancers Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 index 90eafce05..cb441035f 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 @@ -39,6 +39,7 @@ function New-VSElasticLoadBalancingV2ListenerRule { .PARAMETER Priority The rule priority. A listener can't have multiple rules with the same priority. +If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-priority PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 index 964dc814f..5e76ca251 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 @@ -38,7 +38,7 @@ If you don't specify a name, AWS CloudFormation generates a unique physical ID f .PARAMETER Scheme The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. -The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer. +The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme @@ -57,7 +57,7 @@ The default is an Internet-facing load balancer. .PARAMETER SubnetMappings The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. -Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet. +Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings DuplicatesAllowed: False @@ -66,7 +66,7 @@ Network Load Balancers] You can specify subnets from one or more Availability Zo UpdateType: Immutable .PARAMETER Subnets - The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. + The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. Application Load Balancers] You must specify subnets from at least two Availability Zones. When you specify subnets for an existing Application Load Balancer, they replace the previously enabled subnets. Network Load Balancers] You can specify subnets from one or more Availability Zones when you create the load balancer. You can't change the subnets for an existing Network Load Balancer. @@ -77,7 +77,7 @@ Network Load Balancers] You can specify subnets from one or more Availability Zo UpdateType: Mutable .PARAMETER Tags - The tags. Each resource can have a maximum of 10 tags. + One or more tags to assign to the load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags DuplicatesAllowed: True @@ -196,16 +196,8 @@ Network Load Balancers] You can specify subnets from one or more Availability Zo $SubnetMappings, [parameter(Mandatory = $false)] $Subnets, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 index 4a5064f13..611e38d74 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 @@ -43,7 +43,7 @@ Before you register a Lambda function as a target, you must create a AWS::Lambda UpdateType: Mutable .PARAMETER HealthCheckProtocol - The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks. + The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol PrimitiveType: String @@ -86,14 +86,14 @@ This name must be unique per region per account, can have a maximum of 32 charac UpdateType: Immutable .PARAMETER Protocol - The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. If the target is a Lambda function, this parameter does not apply. + The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol PrimitiveType: String UpdateType: Immutable .PARAMETER Tags - The tags. Each resource can have a maximum of 10 tags. + The tags. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags DuplicatesAllowed: True @@ -112,7 +112,7 @@ This name must be unique per region per account, can have a maximum of 32 charac .PARAMETER TargetType The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. -+ instance - Targets are specified by instance ID. This is the default value. ++ instance - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance. + ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud VPC for the target group, the RFC 1918 range 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16, and the RFC 6598 range 100.64.0.0/10. You can't specify publicly routable IP addresses. + lambda - The target groups contains a single Lambda function. @@ -137,7 +137,7 @@ This name must be unique per region per account, can have a maximum of 32 charac UpdateType: Mutable .PARAMETER VpcId - The identifier of the virtual private cloud VPC. If the target is a Lambda function, this parameter does not apply. + The identifier of the virtual private cloud VPC. If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid PrimitiveType: String @@ -300,16 +300,8 @@ This name must be unique per region per account, can have a maximum of 32 charac } })] $Protocol, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 b/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 index bed4e7a40..21e9f8eda 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 @@ -29,6 +29,8 @@ function New-VSElasticsearchDomain { UpdateType: Mutable .PARAMETER CognitoOptions + Configures Amazon ES to use Amazon Cognito authentication for Kibana. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions Type: CognitoOptions UpdateType: Mutable @@ -57,6 +59,7 @@ If you specify a name, you cannot perform updates that require replacement of th .PARAMETER ElasticsearchVersion The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that Amazon ES supports, see the Elasticsearch-Version parameter for the CreateElasticsearchDomain: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-actions-createelasticsearchdomain action in the *Amazon Elasticsearch Service Developer Guide*. +If you set the UpgradeElasticsearchVersion: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeelasticsearchversion update policy to true, you can update ElasticsearchVersion without interruption. When UpgradeElasticsearchVersion is set to false, or is not specified, updating ElasticsearchVersion results in replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion PrimitiveType: String @@ -70,6 +73,8 @@ If you specify a name, you cannot perform updates that require replacement of th UpdateType: Immutable .PARAMETER LogPublishingOptions + Key-value pairs to configure slow log publishing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions DuplicatesAllowed: False ItemType: LogPublishingOption @@ -210,16 +215,8 @@ If you specify a name, you cannot perform updates that require replacement of th $NodeToNodeEncryptionOptions, [parameter(Mandatory = $false)] $SnapshotOptions, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $VPCOptions, diff --git a/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 b/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 index 15d6caf41..b79b7dd50 100644 --- a/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 @@ -1,10 +1,10 @@ function New-VSEventSchemasDiscoverer { <# .SYNOPSIS - Adds an AWS::EventSchemas::Discoverer resource to the template. + Adds an AWS::EventSchemas::Discoverer resource to the template. Use the AWS::EventSchemas::Discoverer resource to specify a *discoverer* that is associated with an event bus. A discoverer allows the Amazon EventBridge Schema Registry to automatically generate schemas based on events on an event bus. .DESCRIPTION - Adds an AWS::EventSchemas::Discoverer resource to the template. + Adds an AWS::EventSchemas::Discoverer resource to the template. Use the AWS::EventSchemas::Discoverer resource to specify a *discoverer* that is associated with an event bus. A discoverer allows the Amazon EventBridge Schema Registry to automatically generate schemas based on events on an event bus. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html @@ -13,16 +13,22 @@ function New-VSEventSchemasDiscoverer { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description for the discoverer. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-description PrimitiveType: String UpdateType: Mutable .PARAMETER SourceArn + The ARN of the event bus. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-sourcearn PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Tags associated with the resource. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-tags ItemType: TagsEntry diff --git a/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 b/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 index b7b3995c5..92a4e1763 100644 --- a/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 @@ -1,10 +1,10 @@ function New-VSEventSchemasRegistry { <# .SYNOPSIS - Adds an AWS::EventSchemas::Registry resource to the template. + Adds an AWS::EventSchemas::Registry resource to the template. Use the AWS::EventSchemas::Registry to specify a schema registry. Schema registries are containers for Schemas. Registries collect and organize schemas so that your schemas are in logical groups. .DESCRIPTION - Adds an AWS::EventSchemas::Registry resource to the template. + Adds an AWS::EventSchemas::Registry resource to the template. Use the AWS::EventSchemas::Registry to specify a schema registry. Schema registries are containers for Schemas. Registries collect and organize schemas so that your schemas are in logical groups. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html @@ -13,16 +13,22 @@ function New-VSEventSchemasRegistry { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the registry to be created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-description PrimitiveType: String UpdateType: Mutable .PARAMETER RegistryName + The name of the schema registry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-registryname PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Tags to associate with the registry. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-tags ItemType: TagsEntry diff --git a/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 b/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 index 72e87297f..5185eb89c 100644 --- a/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 @@ -1,10 +1,10 @@ function New-VSEventSchemasSchema { <# .SYNOPSIS - Adds an AWS::EventSchemas::Schema resource to the template. + Adds an AWS::EventSchemas::Schema resource to the template. Use the AWS::EventSchemas::Schema resource to specify an event schema. .DESCRIPTION - Adds an AWS::EventSchemas::Schema resource to the template. + Adds an AWS::EventSchemas::Schema resource to the template. Use the AWS::EventSchemas::Schema resource to specify an event schema. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html @@ -13,31 +13,43 @@ function New-VSEventSchemasSchema { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type + The type of schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-type PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A description of the schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-description PrimitiveType: String UpdateType: Mutable .PARAMETER Content + The source of the schema definition. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-content PrimitiveType: String UpdateType: Mutable .PARAMETER RegistryName + The name of the schema registry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-registryname PrimitiveType: String UpdateType: Immutable .PARAMETER SchemaName + The name of the schema. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-schemaname PrimitiveType: String UpdateType: Immutable .PARAMETER Tags + Tags associated with the schema. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-tags ItemType: TagsEntry diff --git a/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 b/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 index abd05040a..d79d4f8c7 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 @@ -1,10 +1,14 @@ function New-VSEventsEventBus { <# .SYNOPSIS - Adds an AWS::Events::EventBus resource to the template. + Adds an AWS::Events::EventBus resource to the template. The AWS::Events::EventBus resource creates or updates a partner event bus or custom event bus. Partner event buses can receive events from applications and services created by AWS SaaS partners. You need to create a partner event bus for each partner event source that you want to receive events from. .DESCRIPTION - Adds an AWS::Events::EventBus resource to the template. + Adds an AWS::Events::EventBus resource to the template. The AWS::Events::EventBus resource creates or updates a partner event bus or custom event bus. Partner event buses can receive events from applications and services created by AWS SaaS partners. You need to create a partner event bus for each partner event source that you want to receive events from. + +Custom event buses can receive events from your own custom applications. + +To review the limit for how many rules each event bus may have, see Service Limits: https://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html @@ -13,11 +17,16 @@ function New-VSEventsEventBus { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EventSourceName + The name of the partner event source to associate with this event bus, if you are creating a partner event bus. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename PrimitiveType: String UpdateType: Immutable .PARAMETER Name + The name of the event bus you are creating. The names of custom event buses can't contain the / character. You can't use the name default for a custom event bus. +If you are creating a partner event bus, this name must exactly match the name of the partner event source that this bus is matched to. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 index 62a361a06..63af51d87 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 @@ -1,10 +1,10 @@ function New-VSEventsEventBusPolicy { <# .SYNOPSIS - Adds an AWS::Events::EventBusPolicy resource to the template. The AWS::Events::EventBusPolicy resource creates an event bus policy for Amazon CloudWatch Events. An event bus policy enables your account to receive events from other AWS accounts. These events can trigger CloudWatch Events rules created in your account. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEvents-CrossAccountEventDelivery.html in the *Amazon CloudWatch Events User Guide*. + Adds an AWS::Events::EventBusPolicy resource to the template. The AWS::Events::EventBusPolicy resource creates an event bus policy for Amazon EventBridge. An event bus policy enables your account to receive events from other AWS accounts. These events can trigger EventBridge rules created in your account. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html in the *Amazon EventBridge User Guide*. .DESCRIPTION - Adds an AWS::Events::EventBusPolicy resource to the template. The AWS::Events::EventBusPolicy resource creates an event bus policy for Amazon CloudWatch Events. An event bus policy enables your account to receive events from other AWS accounts. These events can trigger CloudWatch Events rules created in your account. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEvents-CrossAccountEventDelivery.html in the *Amazon CloudWatch Events User Guide*. + Adds an AWS::Events::EventBusPolicy resource to the template. The AWS::Events::EventBusPolicy resource creates an event bus policy for Amazon EventBridge. An event bus policy enables your account to receive events from other AWS accounts. These events can trigger EventBridge rules created in your account. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html in the *Amazon EventBridge User Guide*. If you grant permissions using Condition and specifying an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. @@ -17,6 +17,8 @@ The permission policy on the default event bus can't exceed 10 KB in size. The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER EventBusName + The name of the event bus to associate with this policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 b/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 index e9159739a..980f717c6 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 @@ -1,14 +1,14 @@ function New-VSEventsRule { <# .SYNOPSIS - Adds an AWS::Events::Rule resource to the template. The AWS::Events::Rule resource creates a rule that matches incoming events and routes them to one or more targets for processing. For more information, see What Is Amazon CloudWatch Events?: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html. + Adds an AWS::Events::Rule resource to the template. The AWS::Events::Rule resource creates a rule that matches incoming events and routes them to one or more targets for processing. For more information, see What Is Amazon Eventbridge?: https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html. .DESCRIPTION - Adds an AWS::Events::Rule resource to the template. The AWS::Events::Rule resource creates a rule that matches incoming events and routes them to one or more targets for processing. For more information, see What Is Amazon CloudWatch Events?: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html. + Adds an AWS::Events::Rule resource to the template. The AWS::Events::Rule resource creates a rule that matches incoming events and routes them to one or more targets for processing. For more information, see What Is Amazon Eventbridge?: https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPattern are triggered when a matching event is observed. Rules with ScheduleExpression self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. -Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs. However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match. +Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs. However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html @@ -24,12 +24,17 @@ Most services in AWS treat : or / as the same character in Amazon Resource Names UpdateType: Mutable .PARAMETER EventBusName + The event bus to associate with this rule. If you omit this, the default event bus is used. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname PrimitiveType: String UpdateType: Immutable .PARAMETER EventPattern - Describes which events CloudWatch Events routes to the specified target. For more information, see Event Patterns in CloudWatch Events: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html in the *Amazon CloudWatch Events User Guide*. + Describes which events are routed to the specified target. For more information, see Events and Event Patterns in EventBridge: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html in the *Amazon EventBridge User Guide*. +When using CloudFormation, you must enclose each part of the event pattern in square brackets, as follows: +"EventPattern": { "source": "aws.ec2" ], "detail-type": "EC2 Instance State-change Notification" ] } +A rule must contain either EventPattern or ScheduleExpression. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern PrimitiveType: Json @@ -45,13 +50,15 @@ If you specify a name, you can't perform updates that require replacement of thi .PARAMETER RoleArn The Amazon Resource Name ARN of the role that is used for target invocation. +If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduleExpression - The scheduling expression that determines when and how often the rule runs. For more information, see Schedule Expressions for Rules: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html. + The scheduling expression that determines when and how often the rule runs. For more information, see Schedule Expressions for Rules: https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html. +A rule must contain either ScheduleExpression or EventPattern. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression PrimitiveType: String @@ -65,8 +72,8 @@ If you specify a name, you can't perform updates that require replacement of thi UpdateType: Mutable .PARAMETER Targets - The resources that CloudWatch Events routes events to and invokes when the rule is triggered. For information about valid targets, see PutTargets: https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutTargets.html. -If you're setting the event bus of another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEvents-CrossAccountEventDelivery.html in the *Amazon CloudWatch Events User Guide*. + The AWS resources that are invoked when the rule is triggered. For information about valid targets, see PutTargets: https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutTargets.html. +If you're setting the event bus of another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html in the *Amazon EventBridge User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 b/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 index 7f40a55de..df7b2d414 100644 --- a/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 @@ -1,10 +1,10 @@ function New-VSFMSNotificationChannel { <# .SYNOPSIS - Adds an AWS::FMS::NotificationChannel resource to the template. + Adds an AWS::FMS::NotificationChannel resource to the template. Designates the IAM role and Amazon Simple Notification Service (SNS topic that AWS Firewall Manager uses to record SNS logs. .DESCRIPTION - Adds an AWS::FMS::NotificationChannel resource to the template. + Adds an AWS::FMS::NotificationChannel resource to the template. Designates the IAM role and Amazon Simple Notification Service (SNS topic that AWS Firewall Manager uses to record SNS logs. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-notificationchannel.html @@ -13,11 +13,15 @@ function New-VSFMSNotificationChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SnsRoleName + The Amazon Resource Name ARN of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-notificationchannel.html#cfn-fms-notificationchannel-snsrolename UpdateType: Mutable PrimitiveType: String .PARAMETER SnsTopicArn + The Amazon Resource Name ARN of the SNS topic that collects notifications from AWS Firewall Manager. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-notificationchannel.html#cfn-fms-notificationchannel-snstopicarn UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 index 6b9749921..fc1ee3f5a 100644 --- a/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 @@ -1,10 +1,22 @@ function New-VSFMSPolicy { <# .SYNOPSIS - Adds an AWS::FMS::Policy resource to the template. + Adds an AWS::FMS::Policy resource to the template. An AWS Firewall Manager policy. .DESCRIPTION - Adds an AWS::FMS::Policy resource to the template. + Adds an AWS::FMS::Policy resource to the template. An AWS Firewall Manager policy. + +Firewall Manager provides the following types of policies: + ++ A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources. + ++ An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. + ++ A security group policy, which manages VPC security groups across your AWS organization. + +Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. + +These policies require some setup to use. For more information, see the sections on prerequisites and getting started under AWS Firewall Manager: https://docs.aws.amazon.com/waf/latest/developerguide/fms-prereq.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html @@ -13,58 +25,90 @@ function New-VSFMSPolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ExcludeMap + Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy. +The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : “accountID1”, “accountID2”]}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-excludemap UpdateType: Mutable Type: IEMap .PARAMETER ExcludeResourceTags + Used only when tags are specified in the ResourceTags property. If this property is True, resources with the specified tags are not in scope of the policy. If it's False, only resources with the specified tags are in scope of the policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-excluderesourcetags UpdateType: Mutable PrimitiveType: Boolean .PARAMETER IncludeMap + Specifies the AWS account IDs to include in the policy. If IncludeMap is not set, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is set, only values listed in IncludeMap are included in the policy. +The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : “accountID1”, “accountID2”]}. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-includemap UpdateType: Mutable Type: IEMap .PARAMETER PolicyName + The friendly name of the AWS Firewall Manager policy. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-policyname UpdateType: Mutable PrimitiveType: String .PARAMETER RemediationEnabled + Indicates if the policy should be automatically applied to new resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-remediationenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER ResourceTags + An array of ResourceTag objects, used to explicitly include resources in the policy scope or explicitly exclude them. If this isn't set, then tags aren't used to modify policy scope. See also ExcludeResourceTags. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetags UpdateType: Mutable Type: List ItemType: ResourceTag .PARAMETER ResourceType + The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetype UpdateType: Mutable PrimitiveType: String .PARAMETER ResourceTypeList + An array of ResourceType. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetypelist UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER SecurityServicePolicyData + Details about the security service that is being used to protect the resources. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-securityservicepolicydata UpdateType: Mutable PrimitiveType: Json .PARAMETER DeleteAllPolicyResources + Used when deleting a policy. If true, Firewall Manager performs cleanup according to the policy type. +For AWS WAF and Shield Advanced policies, Firewall Manager does the following: ++ Deletes rule groups created by AWS Firewall Manager ++ Removes web ACLs from in-scope resources ++ Deletes web ACLs that contain no rules or rule groups +For security group policies, Firewall Manager does the following for each security group in the policy: ++ Disassociates the security group from in-scope resources ++ Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy +After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-deleteallpolicyresources UpdateType: Mutable PrimitiveType: Boolean .PARAMETER Tags + A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-tags UpdateType: Mutable Type: List diff --git a/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 b/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 index 35c3b1d2e..2cdd3b4db 100644 --- a/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 @@ -13,30 +13,30 @@ function New-VSFSxFileSystem { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER KmsKeyId - The ID of the AWS Key Management Service AWS KMS key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system. + The ID of the AWS Key Management Service AWS KMS key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system. Amazon FSx for Lustre does not support KMS encryption. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid PrimitiveType: String UpdateType: Immutable .PARAMETER StorageCapacity - The storage capacity of the file system. -For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB. -For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB. + The storage capacity of the file system being created. +For Windows file systems, valid values are 32 GiB - 65,536 GiB. +For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagecapacity PrimitiveType: Integer UpdateType: Immutable .PARAMETER FileSystemType - Type of file system. Currently the only supported type is WINDOWS. + The type of Amazon FSx file system, either LUSTRE or WINDOWS. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtype PrimitiveType: String UpdateType: Immutable .PARAMETER LustreConfiguration - The configuration object for Lustre file systems used in the CreateFileSystem operation. + The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE. Type: LustreConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-lustreconfiguration @@ -50,7 +50,8 @@ For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storag UpdateType: Immutable .PARAMETER SubnetIds - The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet. + Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property. +For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. PrimitiveItemType: String Type: List @@ -58,7 +59,7 @@ For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storag UpdateType: Immutable .PARAMETER SecurityGroupIds - A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. This list isn't returned in later describe requests. + A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. PrimitiveItemType: String Type: List @@ -75,7 +76,7 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat UpdateType: Mutable .PARAMETER WindowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. + The configuration object for the Microsoft Windows file system you are creating. This value is required if FileSystemType is set to WINDOWS. Type: WindowsConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration @@ -176,16 +177,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat $SubnetIds, [parameter(Mandatory = $false)] $SecurityGroupIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $WindowsConfiguration, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 index 74d5a9c97..27ee40d4d 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftAlias { <# .SYNOPSIS - Adds an AWS::GameLift::Alias resource to the template. The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift fleet, which you can use to anonymize your fleet. You can reference the alias instead of a specific fleet when you create game sessions. For more information, see the CreateAlias: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateAlias.html action in the *Amazon GameLift API Reference*. + Adds an AWS::GameLift::Alias resource to the template. The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift fleet destination. There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions. .DESCRIPTION - Adds an AWS::GameLift::Alias resource to the template. The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift fleet, which you can use to anonymize your fleet. You can reference the alias instead of a specific fleet when you create game sessions. For more information, see the CreateAlias: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateAlias.html action in the *Amazon GameLift API Reference*. + Adds an AWS::GameLift::Alias resource to the template. The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift fleet destination. There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html @@ -13,14 +13,14 @@ function New-VSGameLiftAlias { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description - Human-readable description of an alias. + A human-readable description of the alias. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description PrimitiveType: String UpdateType: Mutable .PARAMETER Name - Descriptive label that is associated with an alias. Alias names do not need to be unique. + A descriptive label that is associated with an alias. Alias names do not need to be unique. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 index 97cc08a34..5edcc9f95 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftBuild { <# .SYNOPSIS - Adds an AWS::GameLift::Build resource to the template. The AWS::GameLift::Build resource creates a build that includes all of the components to run your game server in an Amazon GameLift (GameLift fleet. + Adds an AWS::GameLift::Build resource to the template. The AWS::GameLift::Build resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build. .DESCRIPTION - Adds an AWS::GameLift::Build resource to the template. The AWS::GameLift::Build resource creates a build that includes all of the components to run your game server in an Amazon GameLift (GameLift fleet. + Adds an AWS::GameLift::Build resource to the template. The AWS::GameLift::Build resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html @@ -13,28 +13,28 @@ function New-VSGameLiftBuild { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name - Descriptive label that is associated with a build. Build names do not need to be unique. + A descriptive label that is associated with a build. Build names do not need to be unique. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name PrimitiveType: String UpdateType: Mutable .PARAMETER OperatingSystem - + CreateBuild: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html in the *Amazon GameLift API Reference* + The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value WINDOWS_2012. This value cannot be changed later. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem PrimitiveType: String UpdateType: Immutable .PARAMETER StorageLocation - Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a the ARN for a role that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in. + Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an S3 bucket that you own. The storage location must specify an S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your S3 bucket. The S3 bucket and your new build must be in the same Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation Type: S3Location UpdateType: Immutable .PARAMETER Version - Version that is associated with this build. Version strings do not need to be unique. + Version information that is associated with this build. Version strings do not need to be unique. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 index ddc732350..1cee5e796 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftFleet { <# .SYNOPSIS - Adds an AWS::GameLift::Fleet resource to the template. The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift fleet to host game servers. A fleet is a set of EC2 instances, each of which is a host in the fleet. For more information, see the CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html action in the *Amazon GameLift API Reference*. + Adds an AWS::GameLift::Fleet resource to the template. The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift fleet to host game servers. A fleet is a set of EC2 instances, each of which can host multiple game sessions. .DESCRIPTION - Adds an AWS::GameLift::Fleet resource to the template. The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift fleet to host game servers. A fleet is a set of EC2 instances, each of which is a host in the fleet. For more information, see the CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html action in the *Amazon GameLift API Reference*. + Adds an AWS::GameLift::Fleet resource to the template. The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift fleet to host game servers. A fleet is a set of EC2 instances, each of which can host multiple game sessions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html @@ -13,35 +13,36 @@ function New-VSGameLiftFleet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER BuildId - Unique identifier for a build to be deployed on the new fleet. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid PrimitiveType: String UpdateType: Immutable .PARAMETER CertificateConfiguration - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security. +Note: This feature requires the AWS Certificate Manager ACM service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported region error. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration Type: CertificateConfiguration UpdateType: Immutable .PARAMETER Description - Human-readable description of a fleet. + A human-readable description of a fleet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description PrimitiveType: String UpdateType: Mutable .PARAMETER DesiredEC2Instances - Number of EC2 instances you want this fleet to host. + The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances PrimitiveType: Integer UpdateType: Mutable .PARAMETER EC2InboundPermissions - Range of IP addresses and port settings that permit inbound traffic to access game sessions that running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet. + A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions DuplicatesAllowed: False @@ -50,28 +51,28 @@ function New-VSGameLiftFleet { UpdateType: Mutable .PARAMETER EC2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. For more information about the instance types that are supported by GameLift, see the EC2InstanceType: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html#gamelift-CreateFleet-request-EC2InstanceType parameter in the *Amazon GameLift API Reference*. + The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types: http://aws.amazon.com/ec2/instance-types/ for detailed descriptions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype PrimitiveType: String UpdateType: Immutable .PARAMETER FleetType - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceRoleARN - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons background processes. Create a role or look up a role's ARN from the IAM dashboard: https://console.aws.amazon.com/iam/ in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn PrimitiveType: String UpdateType: Immutable .PARAMETER LogPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady and specify one or more directory paths in logParameters. See more information in the Server API Reference: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process. + This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady. See more information in the Server API Reference: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths DuplicatesAllowed: False @@ -80,14 +81,14 @@ function New-VSGameLiftFleet { UpdateType: Immutable .PARAMETER MaxSize - Maximum value allowed for the fleet's instance count. Default if not set is 1. + The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER MetricGroups - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups DuplicatesAllowed: False @@ -96,70 +97,72 @@ function New-VSGameLiftFleet { UpdateType: Mutable .PARAMETER MinSize - Minimum value allowed for the fleet's instance count. Default if not set is 0. + The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name - Descriptive label that is associated with a fleet. Fleet names do not need to be unique. + A descriptive label that is associated with a fleet. Fleet names do not need to be unique. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name PrimitiveType: String UpdateType: Mutable .PARAMETER NewGameSessionProtectionPolicy - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy PrimitiveType: String UpdateType: Mutable .PARAMETER PeerVpcAwsAccountId - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid PrimitiveType: String UpdateType: Immutable .PARAMETER PeerVpcId - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard: https://console.aws.amazon.com/vpc/ in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourceCreationLimitPolicy - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy Type: ResourceCreationLimitPolicy UpdateType: Mutable .PARAMETER RuntimeConfiguration - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. +This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration Type: RuntimeConfiguration UpdateType: Mutable .PARAMETER ScriptId - + CreateFleet: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html in the *Amazon GameLift API Reference* + A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created. +Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid PrimitiveType: String UpdateType: Immutable .PARAMETER ServerLaunchParameters - The parameters that are required to launch your game server. Specify these parameters as a string of command-line parameters, such as +sv_port 33435 +start_lobby. + This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters PrimitiveType: String UpdateType: Immutable .PARAMETER ServerLaunchPath - The location of your game server that GameLift launches. You must escape the slashes and use the following pattern: C:gamelaunchpath. For example, if your game server files are in the MyGame folder, the path should be C:gameMyGameserver.exe. + This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 index 738c99c19..130eef7e8 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftGameSessionQueue { <# .SYNOPSIS - Adds an AWS::GameLift::GameSessionQueue resource to the template. + Adds an AWS::GameLift::GameSessionQueue resource to the template. The AWS::GameLift::GameSessionQueue resource establishes a queue for processing requests to create new game sessions. A queue identifies where new game sessions can be hosted by specifying a list of destinations (fleets or aliases. It also sets how long requests can wait in the queue before timing out. You can set up a queue with destinations in multiple Regions. .DESCRIPTION - Adds an AWS::GameLift::GameSessionQueue resource to the template. + Adds an AWS::GameLift::GameSessionQueue resource to the template. The AWS::GameLift::GameSessionQueue resource establishes a queue for processing requests to create new game sessions. A queue identifies where new game sessions can be hosted by specifying a list of destinations (fleets or aliases. It also sets how long requests can wait in the queue before timing out. You can set up a queue with destinations in multiple Regions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html @@ -13,23 +13,31 @@ function New-VSGameLiftGameSessionQueue { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TimeoutInSeconds + The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-timeoutinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER PlayerLatencyPolicies + A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-playerlatencypolicies ItemType: PlayerLatencyPolicy UpdateType: Mutable .PARAMETER Destinations + A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-destinations ItemType: Destination UpdateType: Mutable .PARAMETER Name + A descriptive label that is associated with game session queue. Queue names must be unique within each Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 index 847ae6508..3869f9856 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftMatchmakingConfiguration { <# .SYNOPSIS - Adds an AWS::GameLift::MatchmakingConfiguration resource to the template. + Adds an AWS::GameLift::MatchmakingConfiguration resource to the template. The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and starting game sessions for the match. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Requests for matchmaking specify which configuration to use and provides the player attribute values that are required for the configuration. .DESCRIPTION - Adds an AWS::GameLift::MatchmakingConfiguration resource to the template. + Adds an AWS::GameLift::MatchmakingConfiguration resource to the template. The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and starting game sessions for the match. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Requests for matchmaking specify which configuration to use and provides the player attribute values that are required for the configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html @@ -13,67 +13,93 @@ function New-VSGameLiftMatchmakingConfiguration { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GameProperties + A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process with a request to start a new game session. See Start a Game Session: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gameproperties ItemType: GameProperty UpdateType: Mutable .PARAMETER GameSessionData + A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. See Start a Game Session: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessiondata PrimitiveType: String UpdateType: Mutable .PARAMETER Description + A descriptive label that is associated with matchmaking configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-description PrimitiveType: String UpdateType: Mutable .PARAMETER AcceptanceTimeoutSeconds + The length of time in seconds to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancetimeoutseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER NotificationTarget + An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html for more information. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-notificationtarget PrimitiveType: String UpdateType: Mutable .PARAMETER CustomEventData + Information that is attached to all events related to the matchmaking configuration. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-customeventdata PrimitiveType: String UpdateType: Mutable .PARAMETER Name + A unique identifier for a matchmaking configuration. Matchmaking requests use this name to identify which matchmaking configuration to use. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-name PrimitiveType: String UpdateType: Immutable .PARAMETER AdditionalPlayerCount + The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-additionalplayercount PrimitiveType: Integer UpdateType: Mutable .PARAMETER BackfillMode + The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-backfillmode PrimitiveType: String UpdateType: Mutable .PARAMETER RequestTimeoutSeconds + The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-requesttimeoutseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER AcceptanceRequired + A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancerequired PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RuleSetName + A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetname PrimitiveType: String UpdateType: Mutable .PARAMETER GameSessionQueueArns + Amazon Resource Name ARN: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any Region. + PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessionqueuearns diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 index 24231f6b8..209c7676b 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftMatchmakingRuleSet { <# .SYNOPSIS - Adds an AWS::GameLift::MatchmakingRuleSet resource to the template. + Adds an AWS::GameLift::MatchmakingRuleSet resource to the template. The AWS::GameLift::MatchmakingRuleSet resource creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a matchmaking configuration. .DESCRIPTION - Adds an AWS::GameLift::MatchmakingRuleSet resource to the template. + Adds an AWS::GameLift::MatchmakingRuleSet resource to the template. The AWS::GameLift::MatchmakingRuleSet resource creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a matchmaking configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html @@ -13,11 +13,15 @@ function New-VSGameLiftMatchmakingRuleSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RuleSetBody + A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-rulesetbody PrimitiveType: String UpdateType: Immutable .PARAMETER Name + A unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 index 0a0e23e46..53ebf174d 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 @@ -1,10 +1,10 @@ function New-VSGameLiftScript { <# .SYNOPSIS - Adds an AWS::GameLift::Script resource to the template. + Adds an AWS::GameLift::Script resource to the template. The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. .DESCRIPTION - Adds an AWS::GameLift::Script resource to the template. + Adds an AWS::GameLift::Script resource to the template. The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html @@ -13,16 +13,22 @@ function New-VSGameLiftScript { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Version + The version that is associated with a build or script. Version strings do not need to be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-version PrimitiveType: String UpdateType: Mutable .PARAMETER StorageLocation + The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. + Type: S3Location Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-storagelocation UpdateType: Mutable .PARAMETER Name + A descriptive label that is associated with a script. Script names do not need to be unique. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 b/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 index ab1960c25..bebb7c01a 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 @@ -84,7 +84,7 @@ function New-VSGlueCrawler { UpdateType: Mutable .PARAMETER Tags - The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html in the developer guide. + The tags to use with this crawler. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 index 9598ebff8..f2c882613 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 @@ -35,7 +35,12 @@ You can only use pure Java/Scala libraries with a DevEndpoint. UpdateType: Mutable .PARAMETER Arguments - + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + A map of arguments used to configure the DevEndpoint. +Valid arguments are: ++ "--enable-glue-datacatalog": "" ++ "GLUE_PYTHON_VERSION": "3" ++ "GLUE_PYTHON_VERSION": "2" +You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-arguments PrimitiveType: Json @@ -64,7 +69,11 @@ You can only use pure Java/Scala libraries with a DevEndpoint. UpdateType: Mutable .PARAMETER WorkerType - + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X. ++ For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. ++ For the G.1X worker type, each worker maps to 1 DPU 4 vCPU, 16 GB of memory, 64 GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. ++ For the G.2X worker type, each worker maps to 2 DPU 8 vCPU, 32 GB of memory, 128 GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. +Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-workertype PrimitiveType: String @@ -78,7 +87,10 @@ You can only use pure Java/Scala libraries with a DevEndpoint. UpdateType: Immutable .PARAMETER GlueVersion - + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. +For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version: https://docs.aws.amazon.com/glue/latest/dg/add-job.html in the developer guide. +Development endpoints that are created without specifying a Glue version default to Glue 0.9. +You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-glueversion PrimitiveType: String @@ -100,14 +112,15 @@ You can only use pure Python libraries with a DevEndpoint. Libraries that rely o UpdateType: Mutable .PARAMETER NumberOfWorkers - + DevEndpoint Structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint in the *AWS Glue Developer Guide* + The number of workers of a defined workerType that are allocated to the development endpoint. +The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofworkers PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tags - The tags to use with this DevEndpoint. You can use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html in the developer guide. + The tags to use with this DevEndpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 b/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 index 089216999..53b84c5c0 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 @@ -34,6 +34,8 @@ function New-VSGlueJob { UpdateType: Mutable .PARAMETER Timeout + The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes 48 hours. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-timeout PrimitiveType: Integer UpdateType: Mutable @@ -70,6 +72,8 @@ For information about the key-value pairs that AWS Glue consumes to set up your UpdateType: Mutable .PARAMETER NotificationProperty + Specifies configuration properties of a notification. + Type: NotificationProperty Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-notificationproperty UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 b/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 index fbd57e3e0..92338a155 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 @@ -13,7 +13,9 @@ function New-VSGlueMLTransform { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Role - The name or Amazon Resource Name ARN of the IAM role with the required permissions. This role needs permission to your Amazon Simple Storage Service Amazon S3 sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform. + The name or Amazon Resource Name ARN of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform. ++ This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html. ++ This role needs permission to your Amazon Simple Storage Service Amazon S3 sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-role PrimitiveType: String @@ -56,7 +58,7 @@ MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType. UpdateType: Mutable .PARAMETER GlueVersion - For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions: https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions in the developer guide. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-glueversion PrimitiveType: String @@ -78,14 +80,13 @@ MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType. .PARAMETER NumberOfWorkers The number of workers of a defined workerType that are allocated when a task of the transform runs. +If WorkerType is set, then NumberOfWorkers is required and vice versa. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-numberofworkers PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name - A user-defined name for the machine learning transform. Names are required to be unique. Name is optional. If you supply Name, the stack cannot be repeatedly created. - Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-name PrimitiveType: String UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 b/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 index dcf20f531..f1d6806b8 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 @@ -20,6 +20,8 @@ function New-VSGlueTrigger { UpdateType: Mutable .PARAMETER StartOnCreation + Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-startoncreation PrimitiveType: Boolean UpdateType: Mutable @@ -40,6 +42,8 @@ function New-VSGlueTrigger { UpdateType: Mutable .PARAMETER WorkflowName + The name of the workflow associated with the trigger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-workflowname PrimitiveType: String UpdateType: Immutable @@ -52,7 +56,7 @@ function New-VSGlueTrigger { UpdateType: Mutable .PARAMETER Tags - The tags to use with this trigger. You can use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html in the developer guide.. + The tags to use with this trigger. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 b/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 index 9427a1146..78c79207a 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 @@ -1,10 +1,10 @@ function New-VSGlueWorkflow { <# .SYNOPSIS - Adds an AWS::Glue::Workflow resource to the template. + Adds an AWS::Glue::Workflow resource to the template. The AWS::Glue::Workflow is an AWS Glue resource type that manages AWS Glue workflows. A workflow is a container for a set of related jobs, crawlers, and triggers in AWS Glue. Using a workflow, you can design a complex multi-job extract, transform, and load (ETL activity that AWS Glue can execute and track as single entity .DESCRIPTION - Adds an AWS::Glue::Workflow resource to the template. + Adds an AWS::Glue::Workflow resource to the template. The AWS::Glue::Workflow is an AWS Glue resource type that manages AWS Glue workflows. A workflow is a container for a set of related jobs, crawlers, and triggers in AWS Glue. Using a workflow, you can design a complex multi-job extract, transform, and load (ETL activity that AWS Glue can execute and track as single entity .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html @@ -13,21 +13,29 @@ function New-VSGlueWorkflow { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A description of the workflow + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-description PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultRunProperties + A collection of properties to be used as part of each execution of the workflow + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-defaultrunproperties PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + The tags to use with this workflow. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the workflow representing the flow + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 b/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 new file mode 100644 index 000000000..cf5ff3c3f --- /dev/null +++ b/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 @@ -0,0 +1,195 @@ +function New-VSGroundStationConfig { + <# + .SYNOPSIS + Adds an AWS::GroundStation::Config resource to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::Config resource to the template. + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html + + .PARAMETER LogicalId + The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. + + .PARAMETER Name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-name + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER Tags + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-tags + UpdateType: Mutable + Type: List + ItemType: Tag + + .PARAMETER ConfigData + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-configdata + UpdateType: Mutable + PrimitiveType: Json + + .PARAMETER DeletionPolicy + With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. + + To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. + + You must use one of the following options: "Delete","Retain","Snapshot" + + + .PARAMETER DependsOn + With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. + + This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. + + + .PARAMETER Metadata + The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. + + You must use a PSCustomObject containing key/value pairs here. This will be returned when describing the resource using AWS CLI. + + + .PARAMETER UpdatePolicy + Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. + + You must use the "Add-UpdatePolicy" function here. + .PARAMETER Condition + Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.Config')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true,Position = 0)] + [ValidateScript( { + if ($_ -match "^[a-zA-Z0-9]*$") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String 'The LogicalID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.')) + } + })] + [System.String] + $LogicalId, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Name, + [VaporShell.Core.TransformTag()] + [parameter(Mandatory = $false)] + $Tags, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","System.Collections.Hashtable","System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $ConfigData, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $DeletionPolicy, + [parameter(Mandatory = $false)] + [System.String[]] + $DependsOn, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "The UpdatePolicy parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Metadata, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.UpdatePolicy" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $UpdatePolicy, + [parameter(Mandatory = $false)] + $Condition + ) + Begin { + $ResourceParams = @{ + LogicalId = $LogicalId + Type = "AWS::GroundStation::Config" + } + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + LogicalId {} + DeletionPolicy { + $ResourceParams.Add("DeletionPolicy",$DeletionPolicy) + } + DependsOn { + $ResourceParams.Add("DependsOn",$DependsOn) + } + Metadata { + $ResourceParams.Add("Metadata",$Metadata) + } + UpdatePolicy { + $ResourceParams.Add("UpdatePolicy",$UpdatePolicy) + } + Condition { + $ResourceParams.Add("Condition",$Condition) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } + ConfigData { + if (($PSBoundParameters[$key]).PSObject.TypeNames -contains "System.String"){ + try { + $JSONObject = (ConvertFrom-Json -InputObject $PSBoundParameters[$key] -ErrorAction Stop) + } + catch { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "Unable to convert parameter '$key' string value to PSObject! Please use a JSON string OR provide a Hashtable or PSCustomObject instead!")) + } + } + else { + $JSONObject = ([PSCustomObject]$PSBoundParameters[$key]) + } + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $key -Value $JSONObject + } + Default { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters[$key] + } + } + } + } + End { + $obj = New-VaporResource @ResourceParams + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.Config' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$(@{$obj.LogicalId = $obj.Props} | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 b/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 new file mode 100644 index 000000000..a166644e8 --- /dev/null +++ b/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 @@ -0,0 +1,169 @@ +function New-VSGroundStationDataflowEndpointGroup { + <# + .SYNOPSIS + Adds an AWS::GroundStation::DataflowEndpointGroup resource to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::DataflowEndpointGroup resource to the template. + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html + + .PARAMETER LogicalId + The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. + + .PARAMETER EndpointDetails + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-endpointdetails + UpdateType: Mutable + Type: List + ItemType: EndpointDetails + + .PARAMETER Tags + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-tags + UpdateType: Mutable + Type: List + ItemType: Tag + + .PARAMETER DeletionPolicy + With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. + + To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. + + You must use one of the following options: "Delete","Retain","Snapshot" + + + .PARAMETER DependsOn + With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. + + This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. + + + .PARAMETER Metadata + The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. + + You must use a PSCustomObject containing key/value pairs here. This will be returned when describing the resource using AWS CLI. + + + .PARAMETER UpdatePolicy + Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. + + You must use the "Add-UpdatePolicy" function here. + .PARAMETER Condition + Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.DataflowEndpointGroup')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true,Position = 0)] + [ValidateScript( { + if ($_ -match "^[a-zA-Z0-9]*$") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String 'The LogicalID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.')) + } + })] + [System.String] + $LogicalId, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.GroundStation.DataflowEndpointGroup.EndpointDetails" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $EndpointDetails, + [VaporShell.Core.TransformTag()] + [parameter(Mandatory = $false)] + $Tags, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $DeletionPolicy, + [parameter(Mandatory = $false)] + [System.String[]] + $DependsOn, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "The UpdatePolicy parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Metadata, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.UpdatePolicy" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $UpdatePolicy, + [parameter(Mandatory = $false)] + $Condition + ) + Begin { + $ResourceParams = @{ + LogicalId = $LogicalId + Type = "AWS::GroundStation::DataflowEndpointGroup" + } + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + LogicalId {} + DeletionPolicy { + $ResourceParams.Add("DeletionPolicy",$DeletionPolicy) + } + DependsOn { + $ResourceParams.Add("DependsOn",$DependsOn) + } + Metadata { + $ResourceParams.Add("Metadata",$Metadata) + } + UpdatePolicy { + $ResourceParams.Add("UpdatePolicy",$UpdatePolicy) + } + Condition { + $ResourceParams.Add("Condition",$Condition) + } + EndpointDetails { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name EndpointDetails -Value @($EndpointDetails) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } + Default { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters[$key] + } + } + } + } + End { + $obj = New-VaporResource @ResourceParams + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.DataflowEndpointGroup' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$(@{$obj.LogicalId = $obj.Props} | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 b/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 new file mode 100644 index 000000000..2a2d4439a --- /dev/null +++ b/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 @@ -0,0 +1,249 @@ +function New-VSGroundStationMissionProfile { + <# + .SYNOPSIS + Adds an AWS::GroundStation::MissionProfile resource to the template. + + .DESCRIPTION + Adds an AWS::GroundStation::MissionProfile resource to the template. + + .LINK + http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html + + .PARAMETER LogicalId + The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. + + .PARAMETER Name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-name + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER ContactPrePassDurationSeconds + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactprepassdurationseconds + UpdateType: Mutable + PrimitiveType: Integer + + .PARAMETER ContactPostPassDurationSeconds + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactpostpassdurationseconds + UpdateType: Mutable + PrimitiveType: Integer + + .PARAMETER MinimumViableContactDurationSeconds + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-minimumviablecontactdurationseconds + UpdateType: Mutable + PrimitiveType: Integer + + .PARAMETER DataflowEdges + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-dataflowedges + UpdateType: Mutable + Type: List + ItemType: DataflowEdge + + .PARAMETER TrackingConfigArn + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-trackingconfigarn + UpdateType: Mutable + PrimitiveType: String + + .PARAMETER Tags + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-tags + UpdateType: Mutable + Type: List + ItemType: Tag + + .PARAMETER DeletionPolicy + With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. + + To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. + + You must use one of the following options: "Delete","Retain","Snapshot" + + + .PARAMETER DependsOn + With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. + + This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. + + + .PARAMETER Metadata + The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. + + You must use a PSCustomObject containing key/value pairs here. This will be returned when describing the resource using AWS CLI. + + + .PARAMETER UpdatePolicy + Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. + + You must use the "Add-UpdatePolicy" function here. + .PARAMETER Condition + Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. + + .FUNCTIONALITY + Vaporshell + #> + [OutputType('Vaporshell.Resource.GroundStation.MissionProfile')] + [cmdletbinding()] + Param + ( + [parameter(Mandatory = $true,Position = 0)] + [ValidateScript( { + if ($_ -match "^[a-zA-Z0-9]*$") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String 'The LogicalID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.')) + } + })] + [System.String] + $LogicalId, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Name, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Int32","Vaporshell.Function" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $ContactPrePassDurationSeconds, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Int32","Vaporshell.Function" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $ContactPostPassDurationSeconds, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.Int32","Vaporshell.Function" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $MinimumViableContactDurationSeconds, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.GroundStation.MissionProfile.DataflowEdge" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $DataflowEdges, + [parameter(Mandatory = $true)] + [ValidateScript( { + $allowedTypes = "System.String","Vaporshell.Function","Vaporshell.Condition" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $TrackingConfigArn, + [VaporShell.Core.TransformTag()] + [parameter(Mandatory = $false)] + $Tags, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $DeletionPolicy, + [parameter(Mandatory = $false)] + [System.String[]] + $DependsOn, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "System.Management.Automation.PSCustomObject" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "The UpdatePolicy parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $Metadata, + [parameter(Mandatory = $false)] + [ValidateScript( { + $allowedTypes = "Vaporshell.Resource.UpdatePolicy" + if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { + $true + } + else { + $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) + } + })] + $UpdatePolicy, + [parameter(Mandatory = $false)] + $Condition + ) + Begin { + $ResourceParams = @{ + LogicalId = $LogicalId + Type = "AWS::GroundStation::MissionProfile" + } + $commonParams = @('Verbose','Debug','ErrorAction','WarningAction','InformationAction','ErrorVariable','WarningVariable','InformationVariable','OutVariable','OutBuffer','PipelineVariable') + } + Process { + foreach ($key in $PSBoundParameters.Keys | Where-Object {$commonParams -notcontains $_}) { + switch ($key) { + LogicalId {} + DeletionPolicy { + $ResourceParams.Add("DeletionPolicy",$DeletionPolicy) + } + DependsOn { + $ResourceParams.Add("DependsOn",$DependsOn) + } + Metadata { + $ResourceParams.Add("Metadata",$Metadata) + } + UpdatePolicy { + $ResourceParams.Add("UpdatePolicy",$UpdatePolicy) + } + Condition { + $ResourceParams.Add("Condition",$Condition) + } + DataflowEdges { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name DataflowEdges -Value @($DataflowEdges) + } + Tags { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Tags -Value @($Tags) + } + Default { + if (!($ResourceParams["Properties"])) { + $ResourceParams.Add("Properties",([PSCustomObject]@{})) + } + $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $key -Value $PSBoundParameters[$key] + } + } + } + } + End { + $obj = New-VaporResource @ResourceParams + $obj | Add-ObjectDetail -TypeName 'Vaporshell.Resource.GroundStation.MissionProfile' + Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$(@{$obj.LogicalId = $obj.Props} | ConvertTo-Json -Depth 5)`n" + } +} diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 index 395026a87..61fbef6cd 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 @@ -13,7 +13,7 @@ function New-VSGuardDutyDetector { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FindingPublishingFrequency - A enumeration value that specifies how frequently finding updates are published. + A enumeration value that specifies how frequently finding updates are published. Valid values include: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS. The default value is SIX_HOURS. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-findingpublishingfrequency PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 b/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 index 40a43e5e1..d4de15b7f 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 @@ -32,7 +32,7 @@ This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex UpdateType: Immutable .PARAMETER Roles - The role associated with the instance profile. + The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-roles DuplicatesAllowed: True diff --git a/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 index 6b65f2abd..acfe89912 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 @@ -20,7 +20,7 @@ For information about limits on the number of inline policies that you can embed .PARAMETER Groups The name of the group to associate the policy with. -®ex-name;. +This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-groups DuplicatesAllowed: True diff --git a/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 b/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 index 088539174..7b5a7392e 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 @@ -13,7 +13,7 @@ function New-VSIAMRole { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AssumeRolePolicyDocument - The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-templateexamples. For more information about the elements that you can use in an IAM policy, see IAM Policy Elements Reference: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html in the *IAM User Guide*. + The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples. For more information about the elements that you can use in an IAM policy, see IAM Policy Elements Reference: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html in the *IAM User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument PrimitiveType: Json @@ -218,16 +218,8 @@ Naming an IAM resource can cause an unrecoverable error if you reuse the same te } })] $RoleName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 b/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 index b5814a7c6..b381a85c9 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 @@ -68,7 +68,8 @@ For information about limits on the number of inline policies that you can embed UpdateType: Mutable .PARAMETER Tags - + CreateUser: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateUser.html in the *AWS Identity and Access Management API Reference* + A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html in the *IAM User Guide*. +If any one of the tags is invalid or if you exceed the allowed number of tags per user, then the entire request fails and the user is not created. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-tags DuplicatesAllowed: True @@ -171,16 +172,8 @@ Naming an IAM resource can cause an unrecoverable error if you reuse the same te } })] $Policies, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 index 729317048..c84bd1eae 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 @@ -129,16 +129,8 @@ function New-VSInspectorAssessmentTemplate { $AssessmentTemplateName, [parameter(Mandatory = $true)] $RulesPackageArns, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $UserAttributesForFindings, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 index bf34f2d9d..c450efa4e 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 @@ -66,16 +66,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat })] [System.String] $LogicalId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $true)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $ResourceGroupTags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 index 9e4e28b2b..383ba8a37 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 @@ -102,16 +102,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat $ChannelStorage, [parameter(Mandatory = $false)] $RetentionPeriod, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 index 83bef984f..167579565 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 @@ -13,7 +13,7 @@ function New-VSIoTAnalyticsDataset { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Actions - The "DatasetAction" objects that automatically create the data set contents. + The DatasetAction objects that automatically create the data set contents. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-actions @@ -28,7 +28,7 @@ function New-VSIoTAnalyticsDataset { UpdateType: Immutable .PARAMETER ContentDeliveryRules - When data set contents are created they are delivered to destinations specified here. + When dataset contents are created they are delivered to destinations specified here. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-contentdeliveryrules @@ -36,7 +36,7 @@ function New-VSIoTAnalyticsDataset { UpdateType: Mutable .PARAMETER Triggers - The "DatasetTrigger" objects that specify when the data set is automatically updated. + The DatasetTrigger objects that specify when the data set is automatically updated. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-triggers @@ -44,14 +44,14 @@ function New-VSIoTAnalyticsDataset { UpdateType: Mutable .PARAMETER VersioningConfiguration - Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version if they are different are kept for the time period specified by the "retentionPeriod" parameter. For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions + Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version if they are different are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions in the *AWS IoT Analytics User Guide*. Type: VersioningConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-versioningconfiguration UpdateType: Mutable .PARAMETER RetentionPeriod - Optional] How long, in days, message data is kept for the data set. + Optional. How long, in days, message data is kept for the data set. Type: RetentionPeriod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-retentionperiod @@ -159,16 +159,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat $VersioningConfiguration, [parameter(Mandatory = $false)] $RetentionPeriod, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 index fb6b441bb..91db86b98 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 @@ -27,7 +27,7 @@ function New-VSIoTAnalyticsDatastore { UpdateType: Immutable .PARAMETER RetentionPeriod - How long, in days, message data is kept for the data store. When "customerManagedS3" storage is selected, this parameter is ignored. + How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored. Type: RetentionPeriod Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-retentionperiod @@ -102,16 +102,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat $DatastoreName, [parameter(Mandatory = $false)] $RetentionPeriod, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 index 92ea060d9..3a5afb5fd 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 @@ -94,16 +94,8 @@ pipelineActivities = { "channel": { ... } }, { "lambda": { ... } }, ... ] } })] $PipelineName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 index 6962a4e90..5adb681b0 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 @@ -1,10 +1,10 @@ function New-VSIoTCertificate { <# .SYNOPSIS - Adds an AWS::IoT::Certificate resource to the template. Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see Authentication in AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/x509-certs.html in the *AWS IoT Developer Guide*. + Adds an AWS::IoT::Certificate resource to the template. Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see X.509 Client Certificates: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html in the *AWS IoT Developer Guide*. .DESCRIPTION - Adds an AWS::IoT::Certificate resource to the template. Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see Authentication in AWS IoT: https://docs.aws.amazon.com/iot/latest/developerguide/x509-certs.html in the *AWS IoT Developer Guide*. + Adds an AWS::IoT::Certificate resource to the template. Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see X.509 Client Certificates: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html in the *AWS IoT Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html @@ -21,6 +21,7 @@ function New-VSIoTCertificate { .PARAMETER Status The status of the certificate. +Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION. The status value REGISTER_INACTIVE is deprecated and should not be used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-status diff --git a/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 b/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 index 9e2c8ae44..731d8b76f 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 @@ -30,7 +30,7 @@ Also, be aware that if you attempt to update several detector models at once usi UpdateType: Mutable .PARAMETER EvaluationMethod - + CreateDetectorModel: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html in the *AWS IoT Events API Reference* + Information about the order in which events are evaluated and how actions are executed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod PrimitiveType: String @@ -51,7 +51,7 @@ Also, be aware that if you attempt to update several detector models at once usi UpdateType: Mutable .PARAMETER Key - The input attribute key used to identify a device or system to create a detector an instance of the detector model and then to route each input received to the appropriate detector instance. This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input. + The input attribute key used to identify a device or system to create a detector an instance of the detector model and then to route each input received to the appropriate detector instance. This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key PrimitiveType: String @@ -175,16 +175,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat } })] $RoleArn, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 b/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 index 7e4ea80c1..09ad0b3ce 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 @@ -111,16 +111,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat } })] $InputDescription, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 b/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 index 4e1551ec9..3f3eac25d 100644 --- a/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 @@ -1,10 +1,14 @@ function New-VSKMSKey { <# .SYNOPSIS - Adds an AWS::KMS::Key resource to the template. The AWS::KMS::Key resource specifies a customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. Authorized users can use the CMK to encrypt and decrypt small amounts of data (up to 4096 bytes, but they are more commonly used to generate data keys. You can also use CMKs to encrypt data stored in AWS services that are integrated with AWS KMS: http://aws.amazon.com/kms/features/#AWS_Service_Integration or within their applications. For more information, see What is the AWS Key Management Service?: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html in the *AWS Key Management Service Developer Guide*. + Adds an AWS::KMS::Key resource to the template. The AWS::KMS::Key resource specifies a symmetric customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. You can use symmetric CMKs to encrypt and decrypt small amounts of data, but they are more commonly used to generate symmetric data keys and asymmetric data key pairs. You can also use symmetric CMKs to encrypt data stored in AWS services that are integrated with AWS KMS: http://aws.amazon.com/kms/features/#AWS_Service_Integration. For more information, see What is the AWS Key Management Service?: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html in the *AWS Key Management Service Developer Guide*. .DESCRIPTION - Adds an AWS::KMS::Key resource to the template. The AWS::KMS::Key resource specifies a customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. Authorized users can use the CMK to encrypt and decrypt small amounts of data (up to 4096 bytes, but they are more commonly used to generate data keys. You can also use CMKs to encrypt data stored in AWS services that are integrated with AWS KMS: http://aws.amazon.com/kms/features/#AWS_Service_Integration or within their applications. For more information, see What is the AWS Key Management Service?: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html in the *AWS Key Management Service Developer Guide*. + Adds an AWS::KMS::Key resource to the template. The AWS::KMS::Key resource specifies a symmetric customer master key: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys (CMK in AWS Key Management Service (AWS KMS. You can use symmetric CMKs to encrypt and decrypt small amounts of data, but they are more commonly used to generate symmetric data keys and asymmetric data key pairs. You can also use symmetric CMKs to encrypt data stored in AWS services that are integrated with AWS KMS: http://aws.amazon.com/kms/features/#AWS_Service_Integration. For more information, see What is the AWS Key Management Service?: https://docs.aws.amazon.com/kms/latest/developerguide/overview.html in the *AWS Key Management Service Developer Guide*. + +**Note** + +AWS KMS does not currently support creating asymmetric CMKs with a CloudFormation template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html @@ -50,7 +54,8 @@ If you are unsure of which policy to use, consider the *default key policy*. Thi UpdateType: Mutable .PARAMETER KeyUsage - The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data. + Determines the cryptographic operations for which you can use the CMK. The default value, ENCRYPT_DECRYPT, is the only valid value for symmetric CMKs. You can't change the KeyUsage value after the CMK is created. +*Allowed Values*: ENCRYPT_DECRYPT Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage PrimitiveType: String @@ -61,6 +66,8 @@ If you are unsure of which policy to use, consider the *default key policy*. Thi When you remove a customer master key CMK from a CloudFormation stack, AWS KMS schedules the CMK for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of CMK is Pending Deletion, which prevents the CMK from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the CMK. You cannot use a CloudFormation template to cancel deletion of the CMK after you remove it from the stack, regardless of the waiting period. If you specify a CMK in your template, even one with the same name, CloudFormation creates a new CMK. To cancel deletion of a CMK, use the AWS KMS console or the CancelKeyDeletion: https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html operation. For information about the PendingDeletion key state, see How Key State Affects Use of a Customer Master Key: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html in the *AWS Key Management Service Developer Guide*. For more information about deleting CMKs, see the ScheduleKeyDeletion: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html operation in the *AWS Key Management Service API Reference* and Deleting Customer Master Keys: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html in the *AWS Key Management Service Developer Guide*. +*Minimum*: 7 +*Maximum*: 30 Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays PrimitiveType: Integer @@ -187,16 +194,8 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat } })] $PendingWindowInDays, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 index 57398af8e..783b8cb8a 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 @@ -20,7 +20,7 @@ function New-VSKinesisAnalyticsV2Application { UpdateType: Immutable .PARAMETER RuntimeEnvironment - The runtime environment for the application SQL-1.0 or FLINK-1_6. + The runtime environment for the application SQL-1.0, FLINK-1_6, or FLINK-1_8. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-runtimeenvironment PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 index 533282b83..52a7a2156 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 @@ -35,7 +35,7 @@ If you specify a name, you cannot perform updates that require replacement of th UpdateType: Mutable .PARAMETER StreamEncryption - Enables or updates server-side encryption using an AWS KMS key for a specified stream. + When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streamencryption Type: StreamEncryption @@ -130,16 +130,8 @@ If you specify a name, you cannot perform updates that require replacement of th $ShardCount, [parameter(Mandatory = $false)] $StreamEncryption, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 index 25ae91f14..aef18f50e 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 @@ -48,6 +48,8 @@ The length constraint applies only to the full ARN. If you specify only the func UpdateType: Immutable .PARAMETER ProvisionedConcurrencyConfig + Specifies a provisioned concurrency configuration for a function's alias. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig Type: ProvisionedConcurrencyConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 index 42639a450..6f7deef5f 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 @@ -1,10 +1,12 @@ function New-VSLambdaEventInvokeConfig { <# .SYNOPSIS - Adds an AWS::Lambda::EventInvokeConfig resource to the template. + Adds an AWS::Lambda::EventInvokeConfig resource to the template. The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html on a version or an alias. .DESCRIPTION - Adds an AWS::Lambda::EventInvokeConfig resource to the template. + Adds an AWS::Lambda::EventInvokeConfig resource to the template. The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html on a version or an alias. + +By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html @@ -13,26 +15,47 @@ function New-VSLambdaEventInvokeConfig { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FunctionName + The name of the Lambda function. +*Minimum*: 1 +*Maximum*: 64 +*Pattern*: a-zA-Z0-9-_]+ + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname PrimitiveType: String UpdateType: Immutable .PARAMETER MaximumRetryAttempts + The maximum number of times to retry when the function returns an error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts PrimitiveType: Integer UpdateType: Mutable .PARAMETER DestinationConfig + A destination for events after they have been sent to a function for processing. +**Destinations** ++ **Function** - The Amazon Resource Name ARN of a Lambda function. ++ **Queue** - The ARN of an SQS queue. ++ **Topic** - The ARN of an SNS topic. ++ **Event Bus** - The ARN of an Amazon EventBridge event bus. + Type: DestinationConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig UpdateType: Mutable .PARAMETER Qualifier + The identifier of a version or alias. ++ **Version** - A version number. ++ **Alias** - An alias name. ++ **Latest** - To specify the unpublished version, use $LATEST. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier PrimitiveType: String UpdateType: Immutable .PARAMETER MaximumEventAgeInSeconds + The maximum age of a request that Lambda sends to a function for processing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds PrimitiveType: Integer UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 index 57c31aba8..b5126f96d 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 @@ -31,11 +31,15 @@ For details about each event source type, see the following topics. UpdateType: Mutable .PARAMETER BisectBatchOnFunctionError + Streams If the function returns an error, split the batch in two and retry. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DestinationConfig + Streams An Amazon SQS queue or Amazon SNS topic destination for discarded records. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig Type: DestinationConfig UpdateType: Mutable @@ -71,29 +75,37 @@ The length constraint applies only to the full ARN. If you specify only the func UpdateType: Mutable .PARAMETER MaximumBatchingWindowInSeconds - The maximum amount of time to gather records before invoking the function, in seconds. + Streams The maximum amount of time to gather records before invoking the function, in seconds. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaximumRecordAgeInSeconds + Streams The maximum age of a record that Lambda sends to a function for processing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER MaximumRetryAttempts + Streams The maximum number of times to retry when the function returns an error. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts PrimitiveType: Integer UpdateType: Mutable .PARAMETER ParallelizationFactor + Streams The number of batches to process from each shard concurrently. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor PrimitiveType: Integer UpdateType: Mutable .PARAMETER StartingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams. + The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. ++ **LATEST** - Read only new records. ++ **TRIM_HORIZON** - Process all available records. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 index b8d78f896..c2ef0d0dc 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 @@ -20,7 +20,7 @@ function New-VSLambdaFunction { UpdateType: Mutable .PARAMETER DeadLetterConfig - A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues: https://docs.aws.amazon.com/lambda/latest/dg/dlq.html. + A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig Type: DeadLetterConfig @@ -123,7 +123,7 @@ If you specify a name, you cannot perform updates that require replacement of th UpdateType: Mutable .PARAMETER VpcConfig - For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings: https://docs.aws.amazon.com/lambda/latest/dg/vpc.html. + For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig Type: VpcConfig @@ -270,16 +270,8 @@ If you specify a name, you cannot perform updates that require replacement of th } })] $Runtime, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 index a48200c4e..9e4fa49fc 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 @@ -50,7 +50,7 @@ You can append a version number or alias to any of the formats. The length const UpdateType: Immutable .PARAMETER SourceAccount - For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account for example, all of an account's Amazon S3 buckets. Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account. + For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 index fa14839fc..69cea5c29 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 @@ -13,14 +13,14 @@ function New-VSLambdaVersion { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER CodeSha256 - Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. + Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256 PrimitiveType: String UpdateType: Mutable .PARAMETER Description - A description for the version to override the description in the function configuration. + A description for the version to override the description in the function configuration. Updates are not supported for this property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description PrimitiveType: String @@ -39,6 +39,8 @@ The length constraint applies only to the full ARN. If you specify only the func UpdateType: Immutable .PARAMETER ProvisionedConcurrencyConfig + Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig Type: ProvisionedConcurrencyConfiguration UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 b/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 index 61255819d..480896cad 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 @@ -15,7 +15,7 @@ The maximum number of metric filters that can be associated with a log group is The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER FilterPattern - A filter pattern for extracting metric data out of ingested log events. + A filter pattern for extracting metric data out of ingested log events. For more information, see Filter and Pattern Syntax: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-filterpattern PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 b/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 index a2d1bfee3..6c21e2ac3 100644 --- a/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 @@ -27,14 +27,14 @@ function New-VSMSKCluster { UpdateType: Mutable .PARAMETER KafkaVersion - The version of Apache Kafka. + The version of Apache Kafka. You can use Amazon MSK to create clusters that use Apache Kafka versions 1.1.1 and 2.2.1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-kafkaversion PrimitiveType: String UpdateType: Immutable .PARAMETER NumberOfBrokerNodes - The number of broker nodes you want in the Amazon MSK cluster. + The number of broker nodes you want in the Amazon MSK cluster. You can submit an update to increase the number of broker nodes in a cluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-numberofbrokernodes PrimitiveType: Integer @@ -48,6 +48,8 @@ function New-VSMSKCluster { UpdateType: Immutable .PARAMETER OpenMonitoring + The settings for open monitoring. + Type: OpenMonitoring Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-openmonitoring UpdateType: Mutable @@ -67,8 +69,7 @@ function New-VSMSKCluster { UpdateType: Immutable .PARAMETER Tags - An array of key-value pairs to apply to this resource. You can specify tags in JSON or in YAML, depending on which format you use for your template. -For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + A map of key:value pairs to apply to this resource. Both key and value are of type String. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 index f0d0bab0b..3b896850d 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 @@ -1,10 +1,14 @@ function New-VSMediaConvertJobTemplate { <# .SYNOPSIS - Adds an AWS::MediaConvert::JobTemplate resource to the template. + Adds an AWS::MediaConvert::JobTemplate resource to the template. The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs. .DESCRIPTION - Adds an AWS::MediaConvert::JobTemplate resource to the template. + Adds an AWS::MediaConvert::JobTemplate resource to the template. The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs. + +When you declare this entity in your AWS CloudFormation template, you pass in your transcoding job settings in JSON or YAML format. This settings specification must be formed in a particular way that conforms to AWS Elemental MediaConvert job validation. For more information about creating a job template model for the SettingsJson property, see the Remarks section later in this topic. + +For information about job templates, see Working with AWS Elemental MediaConvert Job Templates: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html in the *AWS Elemental MediaConvert User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html @@ -13,46 +17,82 @@ function New-VSMediaConvertJobTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Category + Optional. A category for the job template you are creating + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-category PrimitiveType: String UpdateType: Mutable .PARAMETER Description + Optional. A description of the job template you are creating. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-description PrimitiveType: String UpdateType: Mutable .PARAMETER AccelerationSettings + Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. + Type: AccelerationSettings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-accelerationsettings UpdateType: Mutable .PARAMETER Priority + Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0. Minimum: -50 Maximum: 50 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER StatusUpdateInterval + Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. +Specify one of the following enums: +SECONDS_10 +SECONDS_12 +SECONDS_15 +SECONDS_20 +SECONDS_30 +SECONDS_60 +SECONDS_120 +SECONDS_180 +SECONDS_240 +SECONDS_300 +SECONDS_360 +SECONDS_420 +SECONDS_480 +SECONDS_540 +SECONDS_600 + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-statusupdateinterval PrimitiveType: String UpdateType: Mutable .PARAMETER SettingsJson + Specify, in JSON format, the transcoding job settings for this job template. This specification must conform to the AWS Elemental MediaConvert job validation. For information about forming this specification, see the Remarks section later in this topic. +For more information about MediaConvert job templates, see Working with AWS Elemental MediaConvert Job Templates: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html in the *AWS Elemental MediaConvert User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-settingsjson PrimitiveType: Json UpdateType: Mutable .PARAMETER Queue + Optional. The queue that jobs created from this template are assigned to. Specify the Amazon Resource Name ARN of the queue. For example, arn:aws:mediaconvert:us-west-2:505474453218:queues/Default. If you don't specify this, jobs will go to the default queue. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-queue PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the job template you are creating. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 b/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 index f2201a71e..3760c2602 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 @@ -1,10 +1,14 @@ function New-VSMediaConvertPreset { <# .SYNOPSIS - Adds an AWS::MediaConvert::Preset resource to the template. + Adds an AWS::MediaConvert::Preset resource to the template. The AWS::MediaConvert::Preset resource is an AWS Elemental MediaConvert resource type that you can use to specify encoding settings for a single output in a transcoding job. .DESCRIPTION - Adds an AWS::MediaConvert::Preset resource to the template. + Adds an AWS::MediaConvert::Preset resource to the template. The AWS::MediaConvert::Preset resource is an AWS Elemental MediaConvert resource type that you can use to specify encoding settings for a single output in a transcoding job. + +When you declare this entity in your AWS CloudFormation template, you pass in your transcoding job settings in JSON or YAML format. This settings specification must be formed in a particular way that conforms to AWS Elemental MediaConvert job validation. For more information about creating an output preset model for the SettingsJson property, see the Remarks section later in this topic. + +For more information about output MediaConvert presets, see Working with AWS Elemental MediaConvert Output Presets: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html in the *AWS Elemental MediaConvert User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html @@ -13,26 +17,38 @@ function New-VSMediaConvertPreset { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Category + The new category for the preset, if you are changing it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-category PrimitiveType: String UpdateType: Mutable .PARAMETER Description + The new description for the preset, if you are changing it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-description PrimitiveType: String UpdateType: Mutable .PARAMETER SettingsJson + Specify, in JSON format, the transcoding job settings for this output preset. This specification must conform to the AWS Elemental MediaConvert job validation. For information about forming this specification, see the Remarks section later in this topic. +For more information about MediaConvert output presets, see Working with AWS Elemental MediaConvert Output Presets: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html in the *AWS Elemental MediaConvert User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-settingsjson PrimitiveType: Json UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the preset that you are modifying. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 b/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 index 66e2a8185..d10779705 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 @@ -1,10 +1,10 @@ function New-VSMediaConvertQueue { <# .SYNOPSIS - Adds an AWS::MediaConvert::Queue resource to the template. + Adds an AWS::MediaConvert::Queue resource to the template. The AWS::MediaConvert::Queue resource is an AWS Elemental MediaConvert resource type that you can use to manage the resources that are available to your account for parallel processing of jobs. For more information about queues, see Working with AWS Elemental MediaConvert Queues: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html in the *AWS Elemental MediaConvert User Guide*. .DESCRIPTION - Adds an AWS::MediaConvert::Queue resource to the template. + Adds an AWS::MediaConvert::Queue resource to the template. The AWS::MediaConvert::Queue resource is an AWS Elemental MediaConvert resource type that you can use to manage the resources that are available to your account for parallel processing of jobs. For more information about queues, see Working with AWS Elemental MediaConvert Queues: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html in the *AWS Elemental MediaConvert User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html @@ -13,26 +13,38 @@ function New-VSMediaConvertQueue { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Status + Initial state of the queue. Queues can be either ACTIVE or PAUSED. If you create a paused queue, then jobs that you send to that queue won't begin. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-status PrimitiveType: String UpdateType: Mutable .PARAMETER Description + Optional. A description of the queue that you are creating. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-description PrimitiveType: String UpdateType: Mutable .PARAMETER PricingPlan + When you use AWS CloudFormation, you can create only on-demand queues. Therefore, always set PricingPlan to the value "ON_DEMAND" when declaring an AWS::MediaConvert::Queue in your AWS CloudFormation template. +To create a reserved queue, use the AWS Elemental MediaConvert console at https://console.aws.amazon.com/mediaconvert to set up a contract. For more information, see Working with AWS Elemental MediaConvert Queues: https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html in the *AWS Elemental MediaConvert User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-pricingplan PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name + The name of the queue that you are creating. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-name PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 index d7d8bd949..5c3a4f817 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 @@ -12,6 +12,8 @@ Currently, you can create this resource only in AWS Regions in which Amazon Nept If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. +You can use AWS::Neptune::DBCluster.DeletionProtection to help guard against unintended deletion of your DB cluster. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html @@ -28,7 +30,7 @@ If you specify the KmsKeyId, you must enable encryption by setting StorageEncryp UpdateType: Immutable .PARAMETER EngineVersion - The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com + Indicates the database engine version. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-engineversion PrimitiveType: String @@ -50,7 +52,9 @@ If you specify the KmsKeyId, you must enable encryption by setting StorageEncryp UpdateType: Immutable .PARAMETER SnapshotIdentifier - Not supported by Neptune. + Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. +After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. +However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier PrimitiveType: String @@ -92,7 +96,7 @@ If you specify the KmsKeyId, you must enable encryption by setting StorageEncryp UpdateType: Immutable .PARAMETER DeletionProtection - The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com + Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-deletionprotection PrimitiveType: Boolean @@ -338,16 +342,8 @@ An update may require some interruption. See ModifyDBInstance: https://docs.aws. } })] $BackupRetentionPeriod, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $EnableCloudwatchLogsExports, diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 index 1f338c4f3..b85cbb6cb 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 @@ -132,16 +132,8 @@ If you update the parameters, some interruption may occur depending on which par } })] $Family, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 index b31c8ea41..d35c64501 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 @@ -277,16 +277,8 @@ AWS::Neptune::DBCluster does support restoring from snapshots. } })] $DBSnapshotIdentifier, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 index 119995adf..c89871937 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 @@ -138,16 +138,8 @@ Changes to dynamic parameters are applied immediately. During an update, if you } })] $Family, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 index bc27e753e..11ae88fbc 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 @@ -111,16 +111,8 @@ function New-VSNeptuneDBSubnetGroup { $DBSubnetGroupDescription, [parameter(Mandatory = $true)] $SubnetIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 index 163bb6f31..f6a689668 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 @@ -77,7 +77,12 @@ function New-VSOpsWorksCMServer { UpdateType: Immutable .PARAMETER CustomCertificate - + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value: ++ You can provide either a self-signed, custom certificate, or the full certificate chain. ++ The certificate must be a valid X509 certificate, or a certificate chain in PEM format. ++ The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins the certificate's NotBefore date, or after it expires the certificate's NotAfter date. ++ The certificate’s common name or subject alternative names SANs, if present, must match the value of CustomDomain. ++ The certificate must match the value of CustomPrivateKey. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customcertificate PrimitiveType: String @@ -116,14 +121,14 @@ For more information about supported Amazon EC2 platforms, see Supported Platfor UpdateType: Immutable .PARAMETER CustomDomain - + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created the value of the CreateServer Endpoint attribute. You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customdomain PrimitiveType: String UpdateType: Immutable .PARAMETER CustomPrivateKey - + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customprivatekey PrimitiveType: String @@ -139,7 +144,7 @@ For more information about supported Amazon EC2 platforms, see Supported Platfor .PARAMETER EngineAttributes Optional engine attributes on a specified server. **Attributes accepted in a Chef createServer request:** -+ CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. ++ CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline n characters at the end of each line of the pivotal key value. + CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters !/@#$%^&+=_. The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response. **Attributes accepted in a Puppet createServer request:** + PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters. @@ -166,7 +171,12 @@ For more information about supported Amazon EC2 platforms, see Supported Platfor UpdateType: Immutable .PARAMETER Tags - + CreateServer : https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html in the *AWS OpsWorks CM API Reference* + A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. ++ The key cannot be empty. ++ The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / ++ The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / ++ Leading and trailing white spaces are trimmed from both the key and value. ++ A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-tags @@ -416,16 +426,8 @@ For more information about supported Amazon EC2 platforms, see Supported Platfor } })] $InstanceType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 index 3a575de99..4478a232d 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 @@ -321,16 +321,8 @@ The built-in layers' short names are defined by AWS OpsWorks Stacks. For more in } })] $StackId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 index 8cd4a7366..7cb168d92 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 @@ -475,16 +475,8 @@ For more information about how to use AWS OpsWorks Stacks with a VPC, see Runnin } })] $SourceStackId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 index 6f3eb7247..6c9eb0263 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointADMChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::ADMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. + Adds an AWS::Pinpoint::ADMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::ADMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. + Adds an AWS::Pinpoint::ADMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. -The ADM Channel resource represents the status and authentication settings for the ADM channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the ADM channel for an application. +The AWS::Pinpoint::ADMChannel resource defines the status and authentication settings of the ADM channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html @@ -36,7 +36,7 @@ The ADM Channel resource represents the status and authentication settings for t UpdateType: Mutable .PARAMETER ApplicationId - The unique identifier of the Amazon Pinpoint application that the ADM channel applies to. + The unique identifier for the application that the ADM channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-applicationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 index ccae5a266..36dba35dd 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointAPNSChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::APNSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application. -The APNs Channel resource represents the status and authentication settings for the APNs channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the APNs channel for an application. +The AWS::Pinpoint::APNSChannel resource defines the status and authentication settings of the APNs channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html @@ -36,7 +36,7 @@ The APNs Channel resource represents the status and authentication settings for UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-defaultauthenticationmethod PrimitiveType: String @@ -50,28 +50,28 @@ The APNs Channel resource represents the status and authentication settings for UpdateType: Mutable .PARAMETER ApplicationId - The unique identifier of the Amazon Pinpoint application that the APNs channel applies to. + The unique identifier for the application that the APNs channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId - The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens. + The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate - The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. + The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId - The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. + The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 index c1208131d..7a5de0b6a 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointAPNSSandboxChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint application. -The APNs Sandbox Channel resource represents the status and authentication settings of the APNs sandbox channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the APNs sandbox channel for an application. +The AWS::Pinpoint::APNSSandboxChannel resource defines the status and authentication settings of the APNs sandbox channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html @@ -22,21 +22,21 @@ The APNs Sandbox Channel resource represents the status and authentication setti UpdateType: Mutable .PARAMETER PrivateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. + The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-privatekey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled - Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. + Specifies whether to enable the APNs sandbox channel for the application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-defaultauthenticationmethod PrimitiveType: String @@ -50,28 +50,28 @@ The APNs Sandbox Channel resource represents the status and authentication setti UpdateType: Mutable .PARAMETER ApplicationId - The unique identifier of the Amazon Pinpoint application that the APNs sandbox channel applies to. + The unique identifier for the application that the APNs sandbox channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId - The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens. + The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate - The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. + The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId - The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. + The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 index a2285c71b..2f4c6204a 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointAPNSVoipChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSVoipChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint application. -The APNs VoIP Channel resource represents the status and authentication settings of the APNs VoIP channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the APNs VoIP channel for an application. +The AWS::Pinpoint::APNSVoipChannel resource defines the status and authentication settings of the APNs VoIP channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html @@ -29,49 +29,49 @@ The APNs VoIP Channel resource represents the status and authentication settings UpdateType: Mutable .PARAMETER Enabled - Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. + Specifies whether to enable the APNs VoIP channel for the application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-defaultauthenticationmethod PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKey - The authentication key to use for APNs tokens. + The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkey PrimitiveType: String UpdateType: Mutable .PARAMETER ApplicationId - The unique identifier of the Amazon Pinpoint application that the APNs VoIP channel applies to. + The unique identifier for the application that the APNs VoIP channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER TeamId - The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens. + The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-teamid PrimitiveType: String UpdateType: Mutable .PARAMETER Certificate - The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. + The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId - The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. + The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 index 26ace7f79..a817307c9 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointAPNSVoipSandboxChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::APNSVoipSandboxChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs. Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application. -The APNs VoIP Sandbox Channel resource represents the status and authentication settings of the APNs VoIP sandbox channel for a specific app. You can use this resource to retrieve information about, update, or disable (delete the APNs VoIP sandbox channel for an app. +The AWS::Pinpoint::APNSVoipSandboxChannel resource defines the status and authentication settings of the APNs VoIP sandbox channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html @@ -36,7 +36,7 @@ The APNs VoIP Sandbox Channel resource represents the status and authentication UpdateType: Mutable .PARAMETER DefaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate. + The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-defaultauthenticationmethod PrimitiveType: String @@ -64,14 +64,14 @@ The APNs VoIP Sandbox Channel resource represents the status and authentication UpdateType: Mutable .PARAMETER Certificate - The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. + The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-certificate PrimitiveType: String UpdateType: Mutable .PARAMETER TokenKeyId - The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. + The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkeyid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 index 9e4295540..98a3ad37f 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 @@ -1,12 +1,10 @@ function New-VSPinpointApp { <# .SYNOPSIS - Adds an AWS::Pinpoint::App resource to the template. Specifies an app. In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of settings, customer information, segments, and campaigns. + Adds an AWS::Pinpoint::App resource to the template. The AWS::Pinpoint::App resource is an Amazon Pinpoint application, also referred to as a *project* or *app*. An application is a collection of related settings, customer information, segments, campaigns, and other types of Amazon Pinpoint resources. .DESCRIPTION - Adds an AWS::Pinpoint::App resource to the template. Specifies an app. In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of settings, customer information, segments, and campaigns. - -You can use the App resource to retrieve information about or delete an existing application. To create a new application, use the Apps resource and send a POST request to the /apps URI. + Adds an AWS::Pinpoint::App resource to the template. The AWS::Pinpoint::App resource is an Amazon Pinpoint application, also referred to as a *project* or *app*. An application is a collection of related settings, customer information, segments, campaigns, and other types of Amazon Pinpoint resources. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html @@ -15,14 +13,14 @@ You can use the App resource to retrieve information about or delete an existing The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Tags - For more information about using the Ref function, see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html. + A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-tags PrimitiveType: Json UpdateType: Mutable .PARAMETER Name - The display name of the application. + The display name of the application. This name is displayed as the **Project name** on the Amazon Pinpoint console. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 index fde449605..f6c3ffdb6 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 @@ -1,12 +1,10 @@ function New-VSPinpointApplicationSettings { <# .SYNOPSIS - Adds an AWS::Pinpoint::ApplicationSettings resource to the template. Specifies the settings for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::ApplicationSettings resource to the template. The AWS::Pinpoint::ApplicationSettings resource defines the default settings for an Amazon Pinpoint application. In Amazon Pinpoint, an *application* (also referred to as an *app* or *project* is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources. .DESCRIPTION - Adds an AWS::Pinpoint::ApplicationSettings resource to the template. Specifies the settings for an Amazon Pinpoint app. - -In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of settings, customer information, segments, and campaigns. + Adds an AWS::Pinpoint::ApplicationSettings resource to the template. The AWS::Pinpoint::ApplicationSettings resource defines the default settings for an Amazon Pinpoint application. In Amazon Pinpoint, an *application* (also referred to as an *app* or *project* is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html @@ -15,33 +13,33 @@ In Amazon Pinpoint, an *app* (also referred to as a *project* is a collection of The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER QuietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met: -- The EndpointDemographic.Timezone property of the endpoint is set to a valid value. -- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application or a campaign that has custom quiet time settings. -- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application or a campaign that has custom quiet time settings. -If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled. -To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign. + The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: ++ The EndpointDemographic.Timezone property of the endpoint is set to a valid value. ++ The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application or a campaign or journey that has custom quiet time settings. ++ The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application or a campaign or journey that has custom quiet time settings. +If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled. +You can override the default quiet time settings for a specific campaign or journey. Type: QuietTime Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-quiettime UpdateType: Mutable .PARAMETER Limits - The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign. + The default sending limits for campaigns in the application. You can override these limits for a specific campaign. Type: Limits Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-limits UpdateType: Mutable .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app. + The unique identifier for the Amazon Pinpoint application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER CampaignHook - The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign. + The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. You can override these settings for a specific campaign. Type: CampaignHook Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-campaignhook diff --git a/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 index a9d42f2be..17e6a181a 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointBaiduChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::BaiduChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu notification service. Before you use Amazon Pinpoint to send notifications to Baidu, you have to enable the Baidu channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::BaiduChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu Cloud Push notification service. Before you can use Amazon Pinpoint to send notifications to the Baidu Cloud Push service, you have to enable the Baidu channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::BaiduChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu notification service. Before you use Amazon Pinpoint to send notifications to Baidu, you have to enable the Baidu channel for an Amazon Pinpoint app. + Adds an AWS::Pinpoint::BaiduChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu Cloud Push notification service. Before you can use Amazon Pinpoint to send notifications to the Baidu Cloud Push service, you have to enable the Baidu channel for an Amazon Pinpoint application. -The Baidu Channel resource represents the status and authentication settings of the Baidu channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the Baidu channel for an app. +The AWS::Pinpoint::BaiduChannel resource defines the status and authentication settings of the Baidu channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html @@ -36,7 +36,7 @@ The Baidu Channel resource represents the status and authentication settings of UpdateType: Mutable .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app that you're configuring the Baidu channel for. + The unique identifier for the application that the Baidu channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-applicationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 index 5f2c10117..1a42521a4 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointCampaign { <# .SYNOPSIS - Adds an AWS::Pinpoint::Campaign resource to the template. Updates the settings for a campaign. + Adds an AWS::Pinpoint::Campaign resource to the template. A *campaign* is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application. The AWS::Pinpoint::Campaign resource defines the configuration and other settings for a campaign. .DESCRIPTION - Adds an AWS::Pinpoint::Campaign resource to the template. Updates the settings for a campaign. + Adds an AWS::Pinpoint::Campaign resource to the template. A *campaign* is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application. The AWS::Pinpoint::Campaign resource defines the configuration and other settings for a campaign. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html @@ -13,7 +13,7 @@ function New-VSPinpointCampaign { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description - The custom description of the campaign. + A custom description of the campaign. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description PrimitiveType: String @@ -42,7 +42,7 @@ function New-VSPinpointCampaign { UpdateType: Mutable .PARAMETER Name - The custom name of the campaign. + The name of the campaign. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name PrimitiveType: String @@ -56,7 +56,7 @@ function New-VSPinpointCampaign { UpdateType: Mutable .PARAMETER TreatmentDescription - The custom description of a variation of the campaign to use for A/B testing. + A custom description of a variation of the campaign to use for A/B testing. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription PrimitiveType: String @@ -91,7 +91,7 @@ function New-VSPinpointCampaign { UpdateType: Mutable .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app that the campaign is associated with. + The unique identifier for the Amazon Pinpoint application that the campaign is associated with. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid PrimitiveType: String @@ -105,7 +105,7 @@ function New-VSPinpointCampaign { UpdateType: Mutable .PARAMETER Tags - The unique ID of the campaign. + A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 index 9cc1e4fd3..c1d45bd82 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointEmailChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::EmailChannel resource to the template. Updates the status and settings of the email channel for an application. + Adds an AWS::Pinpoint::EmailChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::EmailChannel resource to the template. Updates the status and settings of the email channel for an application. + Adds an AWS::Pinpoint::EmailChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application. + +The AWS::Pinpoint::EmailChannel resource defines the status, identity, and other settings of the email channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html @@ -13,7 +15,7 @@ function New-VSPinpointEmailChannel { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ConfigurationSet - The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API: emailAPIreference.html. + The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-configurationset PrimitiveType: String @@ -34,7 +36,7 @@ function New-VSPinpointEmailChannel { UpdateType: Mutable .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app that you're specifying the email channel for. + The unique identifier for the application that the email channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-applicationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 index 0da7792f8..7a5cda534 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointEmailTemplate { <# .SYNOPSIS - Adds an AWS::Pinpoint::EmailTemplate resource to the template. + Adds an AWS::Pinpoint::EmailTemplate resource to the template. The AWS::Pinpoint::EmailTemplate resource is a message template that you can use in messages that are sent through the email channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications. .DESCRIPTION - Adds an AWS::Pinpoint::EmailTemplate resource to the template. + Adds an AWS::Pinpoint::EmailTemplate resource to the template. The AWS::Pinpoint::EmailTemplate resource is a message template that you can use in messages that are sent through the email channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html @@ -13,36 +13,50 @@ function New-VSPinpointEmailTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER HtmlPart + The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-htmlpart PrimitiveType: String UpdateType: Mutable .PARAMETER TextPart + The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-textpart PrimitiveType: String UpdateType: Mutable .PARAMETER TemplateName + The name of the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-templatename PrimitiveType: String UpdateType: Immutable .PARAMETER TemplateDescription + A custom description of the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-templatedescription PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultSubstitutions + A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-defaultsubstitutions PrimitiveType: String UpdateType: Mutable .PARAMETER Subject + The subject line, or title, to use in email messages that are based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-subject PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 index fe9dcb740..5c2990101 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointEventStream { <# .SYNOPSIS - Adds an AWS::Pinpoint::EventStream resource to the template. Creates a new event stream for an application or updates the settings of an existing event stream for an application. + Adds an AWS::Pinpoint::EventStream resource to the template. You can configure Amazon Pinpoint to stream events to Amazon Kinesis Data Firehose or Amazon Kinesis Data Streams. By streaming events, you enable more flexible options for analysis and storage. The AWS::Pinpoint::EventStream resource defines the settings of an event stream for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::EventStream resource to the template. Creates a new event stream for an application or updates the settings of an existing event stream for an application. + Adds an AWS::Pinpoint::EventStream resource to the template. You can configure Amazon Pinpoint to stream events to Amazon Kinesis Data Firehose or Amazon Kinesis Data Streams. By streaming events, you enable more flexible options for analysis and storage. The AWS::Pinpoint::EventStream resource defines the settings of an event stream for an Amazon Pinpoint application. + +You can configure only one event stream for each Amazon Pinpoint application. To combine data from multiple applications, configure each application to use the same stream. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html @@ -13,7 +15,7 @@ function New-VSPinpointEventStream { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app that you want to export data from. + The unique identifier for the Amazon Pinpoint application that you want to publish event data for. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-applicationid PrimitiveType: String @@ -29,7 +31,7 @@ For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose UpdateType: Mutable .PARAMETER RoleArn - The AWS Identity and Access Management IAM role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. + The Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-rolearn PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 index 30547fed5..ddc1b4fee 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 @@ -6,7 +6,7 @@ function New-VSPinpointGCMChannel { .DESCRIPTION Adds an AWS::Pinpoint::GCMChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM service, which replaced the Google Cloud Messaging (GCM service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application. -The GCM Channel resource represents the status and authentication settings of the GCM channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the GCM channel for an application. +The AWS::Pinpoint::GCMChannel resource defines the status and authentication settings of the GCM channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html @@ -15,21 +15,21 @@ The GCM Channel resource represents the status and authentication settings of th The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ApiKey - The API key, also called the *server key*, that you received from Google to communicate with Google services. + The Web API Key, also referred to as an *API_KEY* or *server key*, that you received from Google to communicate with Google services. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-apikey PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled - Specifies whether to enable the GCM channel for the Amazon Pinpoint application. + Specifies whether to enable the GCM channel for the application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId - The unique identifier for the Amazon Pinpoint app that the GCM channel applies to. + The unique identifier for the application that the GCM channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-applicationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 index ed9a84288..14d479bab 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointPushTemplate { <# .SYNOPSIS - Adds an AWS::Pinpoint::PushTemplate resource to the template. + Adds an AWS::Pinpoint::PushTemplate resource to the template. The AWS::Pinpoint::PushTemplate resource is a message template that you can use in messages that are sent through a push notification channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications. .DESCRIPTION - Adds an AWS::Pinpoint::PushTemplate resource to the template. + Adds an AWS::Pinpoint::PushTemplate resource to the template. The AWS::Pinpoint::PushTemplate resource is a message template that you can use in messages that are sent through a push notification channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html @@ -13,46 +13,64 @@ function New-VSPinpointPushTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER GCM + The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging FCM, formerly Google Cloud Messaging GCM, service. This message template overrides the default template for push notification channels Default. + Type: AndroidPushNotificationTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-gcm UpdateType: Mutable .PARAMETER Baidu + The message template to use for the Baidu Baidu Cloud Push channel. This message template overrides the default template for push notification channels Default. + Type: AndroidPushNotificationTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-baidu UpdateType: Mutable .PARAMETER TemplateName + The name of the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatename PrimitiveType: String UpdateType: Immutable .PARAMETER ADM + The message template to use for the ADM Amazon Device Messaging channel. This message template overrides the default template for push notification channels Default. + Type: AndroidPushNotificationTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-adm UpdateType: Mutable .PARAMETER APNS + The message template to use for the APNs Apple Push Notification service channel. This message template overrides the default template for push notification channels Default. + Type: APNSPushNotificationTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-apns UpdateType: Mutable .PARAMETER TemplateDescription + A custom description of the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatedescription PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultSubstitutions + A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-defaultsubstitutions PrimitiveType: String UpdateType: Mutable .PARAMETER Default + The default message template to use for push notification channels. + Type: DefaultPushNotificationTemplate Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-default UpdateType: Mutable .PARAMETER Tags + A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 index 3353b4a84..b98d2ee4a 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 @@ -1,12 +1,12 @@ function New-VSPinpointSMSChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::SMSChannel resource to the template. A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you use Amazon Pinpoint to send text messages, you have enable the SMS channel for an Amazon Pinpoint application. + Adds an AWS::Pinpoint::SMSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::SMSChannel resource to the template. A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you use Amazon Pinpoint to send text messages, you have enable the SMS channel for an Amazon Pinpoint application. + Adds an AWS::Pinpoint::SMSChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application. -The SMS Channel resource represents the status, sender ID, and other settings for the SMS channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete the SMS channel for an application. +The AWS::Pinpoint::SMSChannel resource defines the status, sender ID, and other settings of the SMS channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html @@ -16,21 +16,21 @@ The SMS Channel resource represents the status, sender ID, and other settings fo .PARAMETER ShortCode The registered short code that you want to use when you send messages through the SMS channel. -For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html in the *Amazon Pinpoint User Guide*. +For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html in the *Amazon Pinpoint User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled - Specifies whether to enable the SMS channel for the app. + Specifies whether to enable the SMS channel for the application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ApplicationId - The unique identifier for the Amazon Pinpoint app that the SMS channel applies to. + The unique identifier for the application that the SMS channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 index 307bda341..0c625f8cf 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointSegment { <# .SYNOPSIS - Adds an AWS::Pinpoint::Segment resource to the template. Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. + Adds an AWS::Pinpoint::Segment resource to the template. A *segment* designates which users receive messages from a campaign or journey, typically a group of customers that share certain attributes. The AWS::Pinpoint::Segment resource defines the configuration, dimension, and other settings for a segment. .DESCRIPTION - Adds an AWS::Pinpoint::Segment resource to the template. Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. + Adds an AWS::Pinpoint::Segment resource to the template. A *segment* designates which users receive messages from a campaign or journey, typically a group of customers that share certain attributes. The AWS::Pinpoint::Segment resource defines the configuration, dimension, and other settings for a segment. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html @@ -13,7 +13,7 @@ function New-VSPinpointSegment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SegmentGroups - The segment group, which consists of zero or more base segments, to use and the dimensions to apply to those base segments in order to build the segment. Your request can include only one segment group. + The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group. Type: SegmentGroups Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentgroups @@ -27,14 +27,14 @@ function New-VSPinpointSegment { UpdateType: Mutable .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app that the segment is associated with. + The unique identifier for the Amazon Pinpoint application that the segment is associated with. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-applicationid PrimitiveType: String UpdateType: Immutable .PARAMETER Tags - The unique identifier for the segment. + A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 index 7e776d3e8..4a75e522a 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 @@ -1,10 +1,10 @@ function New-VSPinpointSmsTemplate { <# .SYNOPSIS - Adds an AWS::Pinpoint::SmsTemplate resource to the template. + Adds an AWS::Pinpoint::SmsTemplate resource to the template. The AWS::Pinpoint::SmsTemplate resource is a message template that you can use in messages that are sent through the SMS channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications. .DESCRIPTION - Adds an AWS::Pinpoint::SmsTemplate resource to the template. + Adds an AWS::Pinpoint::SmsTemplate resource to the template. The AWS::Pinpoint::SmsTemplate resource is a message template that you can use in messages that are sent through the SMS channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html @@ -13,26 +13,36 @@ function New-VSPinpointSmsTemplate { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER TemplateName + The name of the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatename PrimitiveType: String UpdateType: Immutable .PARAMETER TemplateDescription + A custom description of the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatedescription PrimitiveType: String UpdateType: Mutable .PARAMETER DefaultSubstitutions + A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-defaultsubstitutions PrimitiveType: String UpdateType: Mutable .PARAMETER Body + The message body to use in text messages that are based on the message template. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-body PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-tags PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 index e899383d6..0822b9224 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 @@ -1,10 +1,12 @@ function New-VSPinpointVoiceChannel { <# .SYNOPSIS - Adds an AWS::Pinpoint::VoiceChannel resource to the template. Updates the status and settings of the voice channel for an application. + Adds an AWS::Pinpoint::VoiceChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application. .DESCRIPTION - Adds an AWS::Pinpoint::VoiceChannel resource to the template. Updates the status and settings of the voice channel for an application. + Adds an AWS::Pinpoint::VoiceChannel resource to the template. A *channel* is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application. + +The AWS::Pinpoint::VoiceChannel resource defines the status and other settings of the voice channel for an application. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html @@ -20,7 +22,7 @@ function New-VSPinpointVoiceChannel { UpdateType: Mutable .PARAMETER ApplicationId - The unique ID of the Amazon Pinpoint app that you're setting up the voice channel for. + The unique identifier for the Amazon Pinpoint application that the voice channel applies to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-applicationid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 b/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 index 394a57d6f..eedf304fe 100644 --- a/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 +++ b/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 @@ -1,10 +1,12 @@ function New-VSQLDBLedger { <# .SYNOPSIS - Adds an AWS::QLDB::Ledger resource to the template. + Adds an AWS::QLDB::Ledger resource to the template. The AWS::QLDB::Ledger resource creates a new Amazon Quantum Ledger Database (Amazon QLDB ledger in your AWS account. Amazon QLDB is a fully managed ledger database owned by a central trusted authority that provides a transparent, immutable, and cryptographically verifiable transaction log of all of your application changes. .DESCRIPTION - Adds an AWS::QLDB::Ledger resource to the template. + Adds an AWS::QLDB::Ledger resource to the template. The AWS::QLDB::Ledger resource creates a new Amazon Quantum Ledger Database (Amazon QLDB ledger in your AWS account. Amazon QLDB is a fully managed ledger database owned by a central trusted authority that provides a transparent, immutable, and cryptographically verifiable transaction log of all of your application changes. + +For more information, see CreateLedger: https://docs.aws.amazon.com/qldb/latest/developerguide/API_CreateLedger.html in the *Amazon QLDB API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html @@ -13,22 +15,32 @@ function New-VSQLDBLedger { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER PermissionsMode + The permissions mode to assign to the ledger that you want to create. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-permissionsmode PrimitiveType: String UpdateType: Immutable .PARAMETER DeletionProtection + The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled true by default. +If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface AWS CLI. You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-deletionprotection PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Tags + An array of key-value pairs to apply to this resource. +For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-tags ItemType: Tag UpdateType: Mutable .PARAMETER Name + The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-name PrimitiveType: String UpdateType: Immutable @@ -100,16 +112,8 @@ function New-VSQLDBLedger { } })] $DeletionProtection, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 b/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 index 5b4b5ca9b..2611eb66c 100644 --- a/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 @@ -110,16 +110,8 @@ function New-VSRAMResourceShare { $AllowExternalPrincipals, [parameter(Mandatory = $false)] $ResourceArns, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 index fb76e871c..a93b65457 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 @@ -108,6 +108,10 @@ If this argument is omitted, default.aurora5.6 is used. If default.aurora5.6 is UpdateType: Mutable .PARAMETER EnableHttpEndpoint + A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. +When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. +For more information, see Using the Data API for Aurora Serverless: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html in the *Amazon Aurora User Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint PrimitiveType: Boolean UpdateType: Mutable @@ -130,6 +134,11 @@ Valid Values: aurora for MySQL 5.6-compatible Aurora, aurora-mysql for MySQL 5.7 .PARAMETER EngineMode The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. +Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the *Amazon Aurora User Guide*: ++ Limitations of Aurora Serverless: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations ++ Limitations of Parallel Query: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations ++ Requirements for Aurora Global Databases: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations ++ Limitations of Multi-Master Clusters: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode PrimitiveType: String @@ -157,7 +166,7 @@ aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngine .PARAMETER MasterUserPassword The master password for the DB instance. -If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. +If you specify the SourceDBInstanceIdentifier or SnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword PrimitiveType: String @@ -257,7 +266,7 @@ Constraints: .PARAMETER StorageEncrypted Indicates whether the DB instance is encrypted. -If you specify the DBClusterIdentifier, DBSnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. +If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, then you must enable encryption. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted @@ -275,7 +284,6 @@ If you specify the KmsKeyId property, then you must enable encryption. .PARAMETER UseLatestRestorableTime A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. -Constraints: Can't be specified if RestoreToTime parameter is provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime PrimitiveType: Boolean @@ -609,16 +617,8 @@ Constraints: Can't be specified if RestoreToTime parameter is provided. } })] $StorageEncrypted, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 index f4cc03170..9bdad7ec2 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 @@ -8,7 +8,7 @@ function New-VSRDSDBClusterParameterGroup { **Note** -If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the instances are rebooting. +If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html @@ -24,7 +24,12 @@ If you apply a parameter group to a DB cluster, then its DB instances might need UpdateType: Immutable .PARAMETER Family - Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with. + The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. +The DB cluster parameter group family can't be changed when updating a DB cluster parameter group. +To list all of the available parameter group families, use the following command: +aws rds describe-db-engine-versions --query "DBEngineVersions].DBParameterGroupFamily" +The output contains duplicates. +For more information, see CreateDBClusterParameterGroup: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family PrimitiveType: String @@ -124,16 +129,8 @@ If you apply a parameter group to a DB cluster, then its DB instances might need } })] $Parameters, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 index 12072ff37..b20801bf3 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 @@ -55,8 +55,8 @@ If any value is set in the Iops parameter, AllocatedStorage must be at least 100 UpdateType: Mutable .PARAMETER AllowMajorVersionUpgrade - Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. -Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version. + A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. +Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allowmajorversionupgrade PrimitiveType: Boolean @@ -72,18 +72,19 @@ Constraints: This parameter must be set to true when specifying a value for the UpdateType: Mutable .PARAMETER AutoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window. -Default: true + A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-autominorversionupgrade PrimitiveType: Boolean UpdateType: Conditional .PARAMETER AvailabilityZone - The Availability Zone that the database instance will be created in. -Default: A random, system-chosen Availability Zone in the endpoint's region. + The Availability Zone AZ where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html. +Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d -Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint. +Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint. +If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in. +For more information about RDS on VMware, see the *RDS on VMware User Guide.* : https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-availabilityzone PrimitiveType: String @@ -91,22 +92,29 @@ Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ pa .PARAMETER BackupRetentionPeriod The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. +**Amazon Aurora** +Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: -+ Must be a value from 0 to 8 -+ Cannot be set to 0 if the DB Instance is a master instance with read replicas ++ Must be a value from 0 to 35 ++ Can't be set to 0 if the DB instance is a source to Read Replicas Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-backupretentionperiod PrimitiveType: Integer UpdateType: Conditional .PARAMETER CACertificateIdentifier + The identifier of the CA certificate for this DB instance. +Specifying or updating this property triggers a reboot. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-cacertificateidentifier PrimitiveType: String UpdateType: Mutable .PARAMETER CharacterSetName - For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet. + For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. +**Amazon Aurora** +Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-charactersetname PrimitiveType: String @@ -265,13 +273,17 @@ For more information about using Amazon RDS in a VPC, see Using Amazon RDS with .PARAMETER DeletionProtection A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html. +**Amazon Aurora** +Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deletionprotection PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Domain - For an Amazon RDS DB instance that's running Microsoft SQL Server, this parameter specifies the Active Directory directory ID to create the instance in. Amazon RDS uses Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html in the *Amazon RDS User Guide*. + The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. +For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html in the *Amazon RDS User Guide*. +For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html in the *Amazon RDS User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domain PrimitiveType: String @@ -330,14 +342,20 @@ If you don't specify a value for the DBParameterGroupName property, the default .PARAMETER EngineVersion The version number of the database engine to use. +For a list of valid engine versions, use the DescribeDBEngineVersions action. +The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. +**Amazon Aurora** +Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. +**MariaDB** +See MariaDB on Amazon RDS Versions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt in the *Amazon RDS User Guide.* +**Microsoft SQL Server** +See Version and Feature Support on Amazon RDS: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport in the *Amazon RDS User Guide.* **MySQL** -Example: 5.1.42 -Type: String +See MySQL on Amazon RDS Versions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt in the *Amazon RDS User Guide.* **Oracle** -Example: 11.2.0.2.v2 -Type: String -**SQL Server** -Example: 10.50.2789.0.v1 +See Oracle Database Engine Release Notes: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html in the *Amazon RDS User Guide.* +**PostgreSQL** +See Supported PostgreSQL Database Versions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions in the *Amazon RDS User Guide.* Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion PrimitiveType: String @@ -371,14 +389,19 @@ If you've specified DBSecurityGroups and then you update the license model, AWS UpdateType: Mutable .PARAMETER MasterUserPassword - The password for the master database user. Can be any printable ASCII character except "/", "", or "@". -Type: String + The password for the master user. The password can include any printable ASCII character except "/", """, or "@". +**Amazon Aurora** +Not applicable. The password for the master user is managed by the DB cluster. +**MariaDB** +Constraints: Must contain from 8 to 41 characters. +**Microsoft SQL Server** +Constraints: Must contain from 8 to 128 characters. **MySQL** -Constraints: Must contain from 8 to 41 alphanumeric characters. +Constraints: Must contain from 8 to 41 characters. **Oracle** -Constraints: Must contain from 8 to 30 alphanumeric characters. -**SQL Server** -Constraints: Must contain from 8 to 128 alphanumeric characters. +Constraints: Must contain from 8 to 30 characters. +**PostgreSQL** +Constraints: Must contain from 8 to 128 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masteruserpassword PrimitiveType: String @@ -393,6 +416,8 @@ If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, UpdateType: Immutable .PARAMETER MaxAllocatedStorage + The upper limit to which Amazon RDS can automatically scale the storage of the DB instance. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-maxallocatedstorage PrimitiveType: Integer UpdateType: Mutable @@ -422,7 +447,8 @@ If MonitoringInterval is set to a value other than 0, then you must supply a Mon UpdateType: Mutable .PARAMETER OptionGroupName - Indicates that the DB Instance should be associated with the specified option group. + Indicates that the DB instance should be associated with the specified option group. +Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-optiongroupname PrimitiveType: String @@ -451,14 +477,15 @@ If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS u UpdateType: Immutable .PARAMETER PreferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. -Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned. -+ **US-East Northern Virginia Region:** 03:00-11:00 UTC -+ **US-West Northern California Region:** 06:00-14:00 UTC -+ **EU Ireland Region:** 22:00-06:00 UTC -+ **Asia Pacific Singapore Region:** 14:00-22:00 UTC -+ **Asia Pacific Tokyo Region: ** 17:00-03:00 UTC -Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated UTC. Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow in the *Amazon RDS User Guide*. +**Amazon Aurora** +Not applicable. The daily time range for creating automated backups is managed by the DB cluster. +The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow in the *Amazon RDS User Guide*. +Constraints: ++ Must be in the format hh24:mi-hh24:mi. ++ Must be in Universal Coordinated Time UTC. ++ Must not conflict with the preferred maintenance window. ++ Must be at least 30 minutes. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredbackupwindow PrimitiveType: String @@ -508,7 +535,7 @@ If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To sp The SourceDBInstanceIdentifier property determines whether a DB instance is a Read Replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB instance not a Read Replica. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the Read Replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read Replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a Read Replica. -+ If you specify SourceDBInstanceIdentifier, don't set the MultiAZ property to true, and don't specify the DBSnapshotIdentifier property. You can't deploy Read Replicas in multiple Availability Zones, and you can't create a Read Replica from a snapshot. ++ If you specify SourceDBInstanceIdentifier, don't specify the DBSnapshotIdentifier property. You can't create a Read Replica from a snapshot. + Don't set the BackupRetentionPeriod, DBName, MasterUsername, MasterUserPassword, and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for Read Replicas. + If the source DB instance is in a different region than the Read Replica, specify the source region in SourceRegion, and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier. For more information, see Constructing a Amazon RDS Amazon Resource Name ARN: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN in the *Amazon RDS User Guide*. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. @@ -525,7 +552,7 @@ The SourceDBInstanceIdentifier property determines whether a DB instance is a Re UpdateType: Immutable .PARAMETER StorageEncrypted - A value that indicates whether the DB instance is encrypted. By default, it is not encrypted. + A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. **Amazon Aurora** Not applicable. The encryption for DB instances is managed by the DB cluster. @@ -534,7 +561,11 @@ Not applicable. The encryption for DB instances is managed by the DB cluster. UpdateType: Immutable .PARAMETER StorageType - Specifies storage type to be associated with the DB Instance. + Specifies the storage type to be associated with the DB instance. +Valid values: standard | gp2 | io1 +If you specify io1, you must also include a value for the Iops parameter. +Default: io1 if the Iops parameter is specified, otherwise standard +For more information, see Amazon RDS DB Instance Storage: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html in the *Amazon RDS User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storagetype PrimitiveType: String @@ -1135,16 +1166,8 @@ To avoid this situation, migrate your DB instance to using VPC security groups o } })] $StorageType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 index f279b5afb..1c2457f90 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 @@ -19,21 +19,26 @@ Applying a parameter group to a DB instance may require the instance to reboot, The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description - Provides the customer-specified description for this DB Parameter Group. + Provides the customer-specified description for this DB parameter group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description PrimitiveType: String UpdateType: Mutable .PARAMETER Family - Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with. + The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. +The DB parameter group family can't be changed when updating a DB parameter group. +To list all of the available parameter group families, use the following command: +aws rds describe-db-engine-versions --query "DBEngineVersions].DBParameterGroupFamily" +The output contains duplicates. +For more information, see CreateDBParameterGroup: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters - An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. + An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. For more information, see Working with DB Parameter Groups: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html in the *Amazon RDS User Guide*. **MySQL** Valid Values for Apply method: immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots. @@ -125,16 +130,8 @@ Valid Values for Apply method: pending-reboot [parameter(Mandatory = $false)] [System.Collections.Hashtable] $Parameters, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 index ead7df687..d62411d0e 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 @@ -36,7 +36,7 @@ The EC2VpcId property is for backward compatibility with older regions, and is n UpdateType: Immutable .PARAMETER GroupDescription - Provides the description of the DB Security Group. + Provides the description of the DB security group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription PrimitiveType: String @@ -129,16 +129,8 @@ The EC2VpcId property is for backward compatibility with older regions, and is n } })] $GroupDescription, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 index 30530f44e..bf77dd0f0 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 @@ -24,28 +24,28 @@ For details about the settings for DB security group ingress, see AuthorizeDBSec UpdateType: Mutable .PARAMETER DBSecurityGroupName - The name of the DB Security Group to add authorization to. + The name of the DB security group to add authorization to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupId - Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupName - Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname PrimitiveType: String UpdateType: Mutable .PARAMETER EC2SecurityGroupOwnerId - AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 index e30664901..adb898668 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 @@ -13,15 +13,15 @@ function New-VSRDSDBSubnetGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DBSubnetGroupDescription - The description for the DB Subnet Group. + The description for the DB subnet group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription PrimitiveType: String UpdateType: Mutable .PARAMETER DBSubnetGroupName - The name for the DB Subnet Group. This value is stored as a lowercase string. -Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". + The name for the DB subnet group. This value is stored as a lowercase string. +Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname @@ -29,7 +29,7 @@ Example: mySubnetgroup UpdateType: Immutable .PARAMETER SubnetIds - The EC2 Subnet IDs for the DB Subnet Group. + The EC2 Subnet IDs for the DB subnet group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-subnetids DuplicatesAllowed: False @@ -115,16 +115,8 @@ Example: mySubnetgroup $DBSubnetGroupName, [parameter(Mandatory = $true)] $SubnetIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 index 5e9f62443..3b6276d59 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 @@ -13,14 +13,14 @@ function New-VSRDSEventSubscription { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Enabled - A Boolean value; set to **true** to activate the subscription, set to **false** to create the subscription but not active it. + A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EventCategories - A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html topic in the Amazon RDS User Guide or by using the **DescribeEventCategories** action. + A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html topic in the *Amazon RDS User Guide* or by using the **DescribeEventCategories** action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories DuplicatesAllowed: False @@ -36,13 +36,13 @@ function New-VSRDSEventSubscription { UpdateType: Immutable .PARAMETER SourceIds - The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. + The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. Constraints: + If SourceIds are supplied, SourceType must also be provided. + If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. + If the source type is a DB security group, a DBSecurityGroupName must be supplied. + If the source type is a DB parameter group, a DBParameterGroupName must be supplied. -+ If the source type is a DB Snapshot, a DBSnapshotIdentifier must be supplied. ++ If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids DuplicatesAllowed: True @@ -51,8 +51,8 @@ Constraints: UpdateType: Mutable .PARAMETER SourceType - The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. -Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot + The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value isn't specified, all events are returned. +Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 index 6f9d8125b..288447836 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 @@ -140,16 +140,8 @@ function New-VSRDSOptionGroup { } })] $OptionGroupDescription, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 index 4319059d5..01bda857b 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 @@ -35,7 +35,7 @@ Constraints: Must be a value from 0 to 35. .PARAMETER AvailabilityZone The EC2 Availability Zone AZ in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. -Example: us-east-1d +Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone @@ -200,7 +200,7 @@ Constraints: .PARAMETER NodeType The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes in the *Amazon Redshift Cluster Management Guide*. -Valid Values: ds2.xlarge | ds2.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge +Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.16xlarge Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype PrimitiveType: String @@ -603,16 +603,8 @@ Default: The default VPC security group is associated with the cluster. } })] $SnapshotIdentifier, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $VpcSecurityGroupIds, diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 index 99100fad8..1416a78f6 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 @@ -124,16 +124,8 @@ For the workload management WLM configuration, you must supply all the name-valu } })] $Parameters, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 index a44ff00c3..bbc8ed19f 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 @@ -86,16 +86,8 @@ For information about managing security groups, go to Amazon Redshift Cluster Se } })] $Description, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 index cb37a824e..a8dc9b573 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 @@ -97,16 +97,8 @@ For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups $Description, [parameter(Mandatory = $true)] $SubnetIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 index 4d6a8f6e4..74bc2b178 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 @@ -20,7 +20,7 @@ function New-VSRoboMakerRobotApplication { UpdateType: Mutable .PARAMETER RobotSoftwareSuite - The robot software suite used by the robot application. + The robot software suite ROS distribuition used by the robot application. Type: RobotSoftwareSuite Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-robotsoftwaresuite diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 index d4e1d03a9..a3e2034f2 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 @@ -34,7 +34,7 @@ function New-VSRoboMakerSimulationApplication { UpdateType: Mutable .PARAMETER RobotSoftwareSuite - The robot software suite of the simulation application. + The robot software suite ROS distribution used by the simulation application. Type: RobotSoftwareSuite Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-robotsoftwaresuite diff --git a/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 index 10f48139e..d7d0feae8 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 @@ -6,7 +6,7 @@ function New-VSRoute53HealthCheck { .DESCRIPTION Adds an AWS::Route53::HealthCheck resource to the template. The AWS::Route53::HealthCheck resource is a Route 53 resource type that contains settings for a Route 53 health check. -For information about associating health checks with resource record sets, see HealthCheckId: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId in ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html. +For information about associating health checks with records, see HealthCheckId: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId in ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html. **ELB Load Balancers** @@ -14,7 +14,7 @@ If you're registering EC2 instances with an Elastic Load Balancing (ELB load bal **Private Hosted Zones** -You can associate health checks with failover resource record sets in a private hosted zone. Note the following: +You can associate health checks with failover records in a private hosted zone. Note the following: + Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC. diff --git a/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 index 7ba4781d6..771a8cce1 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 @@ -12,7 +12,7 @@ function New-VSRoute53HostedZone { **Important** -You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. +You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new records. For more information about charges for hosted zones, see Amazon Route 53 Pricing: http://aws.amazon.com/route53/pricing/. @@ -22,7 +22,13 @@ Note the following: + For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html in the *Amazon Route 53 Developer Guide*. -If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element. +If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. Using CloudFormation to create reusable delegation sets isn't supported, but you can create them programmatically using other methods, such as the Route 53 API: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html, the AWS CLI: https://docs.aws.amazon.com/cli/latest/reference/route53/create-reusable-delegation-set.html, or AWS SDKs: https://docs.aws.amazon.com/ (see the "SDKs & Toolkits" section. + ++ To create a private hosted zone, specify the VPC ID and Region for one VPC in the VPCs: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs object. + +**Note** + +You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html after you create the hosted zone. + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Making Amazon Route 53 the DNS Service for an Existing Domain: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html in the *Amazon Route 53 Developer Guide*. @@ -35,10 +41,8 @@ When you submit a CreateHostedZone request, the initial status of the hosted zon The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER HostedZoneConfig - Optional A complex type that contains the following optional values: -+ For public and private hosted zones, an optional comment -+ For private hosted zones, an optional PrivateZone element -If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements. + A complex type that contains an optional comment. +If you don't want to specify a comment, omit the HostedZoneConfig and Comment elements. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig Type: HostedZoneConfig @@ -56,7 +60,7 @@ For information about using tags for cost allocation, see Using Cost Allocation .PARAMETER Name The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* without a trailing dot and *www.example.com.* with a trailing dot as identical. -If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet. +If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name PrimitiveType: String @@ -103,7 +107,8 @@ If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the q UpdateType: Mutable .PARAMETER VPCs - A complex type that contains information about the VPCs that are associated with the specified hosted zone. + *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. +For public hosted zones, omit VPCs, VPCId, and VPCRegion. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs DuplicatesAllowed: True diff --git a/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 index f2bf009f9..bb3c99cf1 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 @@ -1,10 +1,12 @@ function New-VSRoute53RecordSet { <# .SYNOPSIS - Adds an AWS::Route53::RecordSet resource to the template. Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. + Adds an AWS::Route53::RecordSet resource to the template. Information about the record that you want to create. .DESCRIPTION - Adds an AWS::Route53::RecordSet resource to the template. Information about the resource record set to create, update, or delete. The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. + Adds an AWS::Route53::RecordSet resource to the template. Information about the record that you want to create. + +The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup. For more information, see ChangeResourceRecordSets: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html in the *Amazon Route 53 API Reference*. @@ -19,7 +21,7 @@ For more information, see ChangeResourceRecordSets: https://docs.aws.amazon.com/ If you're creating resource records sets for a private hosted zone, note the following: + You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. + Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. -+ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html in the *Amazon Route 53 Developer Guide*. ++ For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html in the *Amazon Route 53 Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget Type: AliasTarget @@ -42,8 +44,8 @@ Except where noted, the following failover behaviors assume that you have includ You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets. For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true. For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: -+ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html -+ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html ++ Route 53 Health Checks and DNS Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover PrimitiveType: String @@ -51,11 +53,11 @@ For more information about configuring failover for Route 53, see the following .PARAMETER GeoLocation *Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF. -Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported. +Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported. If you create separate resource record sets for overlapping geographic regions for example, one resource record set for a continent and one for a country on the same continent, priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. You can't create two geolocation resource record sets that specify the same geographic location. The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements. -Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. +Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation @@ -71,8 +73,8 @@ Route 53 determines whether a resource record set is healthy based on one of the Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. For more information, see the following topics in the *Amazon Route 53 Developer Guide*: + How Amazon Route 53 Determines Whether an Endpoint Is Healthy: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html -+ Route 53 Health Checks and DNS Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html -+ Configuring Failover in a Private Hosted Zone: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html ++ Route 53 Health Checks and DNS Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html ++ Configuring Failover in a Private Hosted Zone: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html **When to Specify HealthCheckId** Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: + **Non-alias resource record sets**: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type such as multiple weighted records named www.example.com with a type of A and you specify health check IDs for all the resource record sets. @@ -103,16 +105,17 @@ Health check results will be unpredictable if you do the following: UpdateType: Mutable .PARAMETER HostedZoneId - The ID of the hosted zone that contains the resource record sets that you want to change. + The ID of the hosted zone that you want to create records in. +Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid PrimitiveType: String UpdateType: Immutable .PARAMETER HostedZoneName - The name of the domain for the hosted zone where you want to add the resource record set. + The name of the hosted zone that you want to create records in. When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. -If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using HostedZoneId. +Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename PrimitiveType: String @@ -136,7 +139,7 @@ You can't create multivalue answer alias records. For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. **ChangeResourceRecordSets Only** Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com without a trailing dot and www.example.com. with a trailing dot as identical. -For information about how to specify characters other than a-z, 0-9, and - hyphen and how to specify internationalized domain names, see DNS Domain Name Format: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html in the *Amazon Route 53 Developer Guide*. +For information about how to specify characters other than a-z, 0-9, and - hyphen and how to specify internationalized domain names, see DNS Domain Name Format: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html in the *Amazon Route 53 Developer Guide*. You can use the asterisk * wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following: + The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com. + The * can't replace any of the middle labels, for example, marketing.*.example.com. @@ -151,7 +154,7 @@ You can use the * wildcard as the leftmost label in a domain name, for example, .PARAMETER Region *Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. -Creating latency and latency alias resource record sets in private hosted zones is not supported. +Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. Note the following: + You can only specify one ResourceRecord per latency resource record set. @@ -164,7 +167,11 @@ Note the following: UpdateType: Mutable .PARAMETER ResourceRecords - Information about the resource record sets that you want to add to the hosted zone. Each record should be in the format appropriate for the record type specified by the Type property. For information about different record types and their record formats, see Values That You Specify When You Create or Edit Amazon Route 53 Records: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html in the *Amazon Route 53 Developer Guide*. + One or more values that correspond with the value that you specified for the Type property. For example, if you specified A for Type, you specify one or more IP addresses in IPv4 format for ResourceRecords. For information about the format of values for each record type, see Supported DNS Resource Record Types: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. +Note the following: ++ You can specify more than one value for all record types except CNAME and SOA. ++ The maximum length of a value is 4000 characters. ++ If you're creating an alias record, omit ResourceRecords. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords DuplicatesAllowed: True @@ -192,7 +199,7 @@ For information about routing policies, see Choosing a Routing Policy: https://d UpdateType: Mutable .PARAMETER Type - The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. + The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html in the *Amazon Route 53 Developer Guide*. Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT @@ -201,7 +208,7 @@ Values for alias resource record sets: + **Amazon API Gateway custom regional APIs and edge-optimized APIs:** A + **CloudFront distributions:** A If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA. -+ **AWS Elastic Beanstalk environment that has a regionalized subdomain**: A ++ **Amazon API Gateway environment that has a regionalized subdomain**: A + **ELB load balancers:** A | AAAA + **Amazon S3 buckets:** A + **Amazon Virtual Private Cloud interface VPC endpoints** A @@ -220,7 +227,7 @@ If you're creating an alias record that has the same name as the hosted zone kno + You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets. + You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements. + For weighted but not weighted alias resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. -The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html in the *Amazon Route 53 Developer Guide*. +The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html in the *Amazon Route 53 Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight PrimitiveType: Integer diff --git a/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 index 1a841b7c7..472ba1dc3 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 @@ -1,10 +1,10 @@ function New-VSRoute53RecordSetGroup { <# .SYNOPSIS - Adds an AWS::Route53::RecordSetGroup resource to the template. A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the resource record sets that you want to add, update, or delete. + Adds an AWS::Route53::RecordSetGroup resource to the template. A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the records that you want to create. .DESCRIPTION - Adds an AWS::Route53::RecordSetGroup resource to the template. A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the resource record sets that you want to add, update, or delete. + Adds an AWS::Route53::RecordSetGroup resource to the template. A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the records that you want to create. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html @@ -20,21 +20,24 @@ function New-VSRoute53RecordSetGroup { UpdateType: Mutable .PARAMETER HostedZoneId - The ID of the hosted zone that contains the resource record sets that you want to change. + The ID of the hosted zone that you want to create records in. +Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid PrimitiveType: String UpdateType: Immutable .PARAMETER HostedZoneName - The name of the hosted zone that you want to create, update, or delete resource record sets in. + The name of the hosted zone that you want to create records in. +When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. +Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename PrimitiveType: String UpdateType: Immutable .PARAMETER RecordSets - A complex type that contains one RecordSet element for each resource record set that you want to add, update, or delete. + A complex type that contains one RecordSet element for each record that you want to create. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 index 2beed4064..8d18bbbf8 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 @@ -1,14 +1,14 @@ function New-VSRoute53ResolverResolverEndpoint { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: + Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound: .DESCRIPTION - Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: + Adds an AWS::Route53Resolver::ResolverEndpoint resource to the template. Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound: -+ An *inbound resolver endpoint* forwards DNS queries to the DNS service for a VPC from your network or another VPC. ++ An *inbound Resolver endpoint* forwards DNS queries to the DNS service for a VPC from your network. -+ An *outbound resolver endpoint* forwards DNS queries from the DNS service for a VPC to your network or another VPC. ++ An *outbound Resolver endpoint* forwards DNS queries from the DNS service for a VPC to your network. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html @@ -25,9 +25,9 @@ function New-VSRoute53ResolverResolverEndpoint { UpdateType: Mutable .PARAMETER Direction - Indicates whether the resolver endpoint allows inbound or outbound DNS queries: -+ INBOUND: allows DNS queries to your VPC from your network or another VPC -+ OUTBOUND: allows DNS queries from your VPC to your network or another VPC + Indicates whether the Resolver endpoint allows inbound or outbound DNS queries: ++ INBOUND: allows DNS queries to your VPC from your network ++ OUTBOUND: allows DNS queries from your VPC to your network Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-direction PrimitiveType: String @@ -125,16 +125,8 @@ function New-VSRoute53ResolverResolverEndpoint { $Direction, [parameter(Mandatory = $true)] $SecurityGroupIds, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 index 0e125cd4e..44670eee3 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 @@ -1,10 +1,10 @@ function New-VSRoute53ResolverResolverRule { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverRule resource to the template. For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. + Adds an AWS::Route53Resolver::ResolverRule resource to the template. For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. .DESCRIPTION - Adds an AWS::Route53Resolver::ResolverRule resource to the template. For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. + Adds an AWS::Route53Resolver::ResolverRule resource to the template. For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html @@ -20,14 +20,16 @@ function New-VSRoute53ResolverResolverRule { UpdateType: Mutable .PARAMETER DomainName - DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules example.com and www.example.com, the query is routed using the resolver rule that contains the most specific domain name www.example.com. + DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules example.com and www.example.com, the query is routed using the Resolver rule that contains the most specific domain name www.example.com. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER RuleType - This value is always FORWARD. Other resolver rule types aren't supported. + When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. +When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, choose SYSTEM. +For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-ruletype PrimitiveType: String @@ -50,7 +52,7 @@ function New-VSRoute53ResolverResolverRule { UpdateType: Mutable .PARAMETER Name - The name for the resolver rule, which you specified when you created the resolver rule. + The name for the Resolver rule, which you specified when you created the Resolver rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-name PrimitiveType: String @@ -145,16 +147,8 @@ function New-VSRoute53ResolverResolverRule { } })] $TargetIps, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 index 76b01a610..56ef7a4a1 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 @@ -1,10 +1,10 @@ function New-VSRoute53ResolverResolverRuleAssociation { <# .SYNOPSIS - Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. In the response to an AssociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html, DisassociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html, or ListResolverRuleAssociations: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html request, information about an association between a resolver rule and a VPC. + Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. In the response to an AssociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html, DisassociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html, or ListResolverRuleAssociations: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. .DESCRIPTION - Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. In the response to an AssociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html, DisassociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html, or ListResolverRuleAssociations: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html request, information about an association between a resolver rule and a VPC. + Adds an AWS::Route53Resolver::ResolverRuleAssociation resource to the template. In the response to an AssociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html, DisassociateResolverRule: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html, or ListResolverRuleAssociations: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html @@ -13,21 +13,21 @@ function New-VSRoute53ResolverResolverRuleAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER VPCId - The ID of the VPC that you associated the resolver rule with. + The ID of the VPC that you associated the Resolver rule with. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-vpcid PrimitiveType: String UpdateType: Immutable .PARAMETER ResolverRuleId - The ID of the resolver rule that you associated with the VPC that is specified by VPCId. + The ID of the Resolver rule that you associated with the VPC that is specified by VPCId. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-resolverruleid PrimitiveType: String UpdateType: Immutable .PARAMETER Name - The name of an association between a resolver rule and a VPC. + The name of an association between a Resolver rule and a VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 b/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 index 687277220..38873f114 100644 --- a/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 @@ -1,10 +1,10 @@ function New-VSS3AccessPoint { <# .SYNOPSIS - Adds an AWS::S3::AccessPoint resource to the template. + Adds an AWS::S3::AccessPoint resource to the template. The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. .DESCRIPTION - Adds an AWS::S3::AccessPoint resource to the template. + Adds an AWS::S3::AccessPoint resource to the template. The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html @@ -13,41 +13,57 @@ function New-VSS3AccessPoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Name + The name of this access point. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name UpdateType: Mutable PrimitiveType: String .PARAMETER Bucket + The name of the bucket associated with this access point. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucket UpdateType: Immutable PrimitiveType: String .PARAMETER VpcConfiguration + The Virtual Private Cloud VPC configuration for this access point, if one exists. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-vpcconfiguration UpdateType: Immutable Type: VpcConfiguration .PARAMETER PublicAccessBlockConfiguration + The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the *Amazon Simple Storage Service Developer Guide*. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-publicaccessblockconfiguration UpdateType: Immutable Type: PublicAccessBlockConfiguration .PARAMETER Policy + The access point policy associated with this access point. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policy UpdateType: Mutable PrimitiveType: Json .PARAMETER PolicyStatus + The container element for a bucket's policy status. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policystatus UpdateType: Mutable PrimitiveType: Json .PARAMETER NetworkOrigin + Indicates whether this access point allows access from the internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the internet, subject to the access point and bucket access policies. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-networkorigin UpdateType: Mutable PrimitiveType: String .PARAMETER CreationDate + The date and time when this access point was created. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-creationdate UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 b/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 index ae559fe32..a286eead1 100644 --- a/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 @@ -27,6 +27,7 @@ You can only delete empty buckets. Deletion fails for buckets that have contents .PARAMETER AccessControl A canned access control list ACL that grants predefined permissions to the bucket. For more information about canned ACLs, see Canned ACL: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl in the *Amazon Simple Storage Service Developer Guide*. +Be aware that the syntax for this property differs from the information provided in the *Amazon Simple Storage Service Developer Guide*. The AccessControl property is case-sensitive and must be one of the following values: Private, PublicRead, PublicReadWrite, AuthenticatedRead, LogDeliveryWrite, BucketOwnerRead, BucketOwnerFullControl, or AwsExecRead. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accesscontrol PrimitiveType: String @@ -34,7 +35,6 @@ You can only delete empty buckets. Deletion fails for buckets that have contents .PARAMETER AnalyticsConfigurations Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. -For more information, see GET Bucket analytics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETAnalyticsConfig.html in the *Amazon Simple Storage Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations DuplicatesAllowed: False @@ -104,14 +104,17 @@ If you specify a name, you can't perform updates that require replacement of thi UpdateType: Mutable .PARAMETER ObjectLockConfiguration - Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket. + Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. +DefaultRetention requires either Days or Years. You can't specify both at the same time. +**Related Resources** ++ Locking Objects: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration Type: ObjectLockConfiguration UpdateType: Mutable .PARAMETER ObjectLockEnabled - Indicates whether this bucket has an object lock configuration enabled. + Indicates whether this bucket has an Object Lock configuration enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockenabled PrimitiveType: Boolean @@ -134,7 +137,6 @@ Amazon S3 can store replicated objects in only one destination bucket. The desti .PARAMETER Tags An arbitrary set of tags key-value pairs for this S3 bucket. -We recommend limiting the number of tags to seven. Applying more than seven tags prevents the AWS CLI and the AWS CloudFormation console and API actions from listing the tags for the bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-tags DuplicatesAllowed: True @@ -285,16 +287,8 @@ We recommend limiting the number of tags to seven. Applying more than seven tags $PublicAccessBlockConfiguration, [parameter(Mandatory = $false)] $ReplicationConfiguration, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] $VersioningConfiguration, diff --git a/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 index 4403f3948..3735928af 100644 --- a/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 @@ -1,10 +1,28 @@ function New-VSS3BucketPolicy { <# .SYNOPSIS - Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. + Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. .DESCRIPTION - Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. + Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. + +**Important** + +Only one bucket policy should be applied to a bucket. + +If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. + +**Important** + +As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. + +For more information about bucket policies, see Using Bucket Policies and User Policies: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html. + +The following operations are related to PutBucketPolicy: + ++ CreateBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html + ++ DeleteBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html diff --git a/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 b/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 index 76914821b..d376f9527 100644 --- a/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 @@ -1,18 +1,14 @@ function New-VSSESConfigurationSetEventDestination { <# .SYNOPSIS - Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. Specifies a configuration set event destination. + Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. Specifies a configuration set event destination. An event destination is an AWS service that Amazon SES publishes email sending events to. When you specify an event destination, you provide one, and only one, destination. You can send event data to Amazon CloudWatch or Amazon Kinesis Data Firehose. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. .DESCRIPTION - Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. Specifies a configuration set event destination. + Adds an AWS::SES::ConfigurationSetEventDestination resource to the template. Specifies a configuration set event destination. An event destination is an AWS service that Amazon SES publishes email sending events to. When you specify an event destination, you provide one, and only one, destination. You can send event data to Amazon CloudWatch or Amazon Kinesis Data Firehose. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. **Note** -When you specify an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Data Firehose, or Amazon Simple Notification Service (Amazon SNS. - -An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html. - -You can execute this operation no more than once per second. +You can't specify Amazon SNS event destinations in CloudFormation templates. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html diff --git a/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 index 9323b950f..b8bca5a95 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 @@ -13,7 +13,7 @@ function New-VSSNSSubscription { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DeliveryPolicy - The JSON serialization of the subscription's delivery policy. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference*. + The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference* and Message Delivery Retries: https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html in the *Amazon SNS Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy PrimitiveType: Json @@ -27,7 +27,7 @@ function New-VSSNSSubscription { UpdateType: Immutable .PARAMETER FilterPolicy - The filter policy JSON assigned to the subscription. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference*. + The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages. For more information, see GetSubscriptionAttributes: https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html in the *Amazon Simple Notification Service API Reference* and Message Filtering: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html in the *Amazon SNS Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy PrimitiveType: Json @@ -48,6 +48,8 @@ function New-VSSNSSubscription { UpdateType: Mutable .PARAMETER RedrivePolicy + When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors for example, when the subscribed endpoint is unreachable or server errors for example, when the service that powers the subscribed endpoint becomes unavailable are held in the dead-letter queue for further analysis or reprocessing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy PrimitiveType: Json UpdateType: Mutable diff --git a/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 b/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 index ff63aa80a..44a47317f 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 @@ -10,8 +10,6 @@ function New-VSSNSTopic { One user can create a maximum of 100,000 topics. -This action is idempotent: If the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. - .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html @@ -43,7 +41,8 @@ This property applies only to server-side-encryption: https://docs.aws.amazon.co UpdateType: Mutable .PARAMETER Tags - + Using an AWS CloudFormation Template to Create a Topic that Sends Messages to Amazon SQS Queues: https://docs.aws.amazon.com/sns/latest/dg/SendMessageToSQS.cloudformation.html in the *Amazon Simple Notification Service Developer Guide* + The list of tags to add to a new topic. +To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-tags DuplicatesAllowed: True @@ -138,16 +137,8 @@ If you specify a name, you can't perform updates that require replacement of thi } })] $Subscription, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 b/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 index 7e9315f43..cf69bb515 100644 --- a/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 @@ -58,7 +58,7 @@ A shorter time period provides better security, but results in more calls to AWS UpdateType: Mutable .PARAMETER KmsMasterKeyId - The ID of an AWS managed customer master key CMK for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the alias alias/aws/sqs. For more information, see the following: + The ID of an AWS managed customer master key CMK for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the default alias alias/aws/sqs. For more information, see the following: + Protecting Data Using Server-Side Encryption SSE and AWS KMS: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html in the *Amazon Simple Queue Service Developer Guide* + CreateQueue: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html in the *Amazon Simple Queue Service API Reference* + The Customer Master Keys section of the AWS Key Management Service Best Practices: https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf whitepaper @@ -285,16 +285,8 @@ For more information about Amazon SQS queue visibility timeouts, see Visibility } })] $RedrivePolicy, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 index 30b846480..51c8e1998 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 @@ -27,8 +27,8 @@ function New-VSSSMAssociation { UpdateType: Mutable .PARAMETER InstanceId - The ID of the instance that the SSM document is associated with. -You must specify the InstanceId or Targets property. + The ID of the instance that the SSM document is associated with. You must specify the InstanceId or Targets property. +InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid PrimitiveType: String @@ -65,8 +65,7 @@ You must specify the InstanceId or Targets property. UpdateType: Mutable .PARAMETER Targets - The targets that the SSM document sends commands to. -You must specify the InstanceId or Targets property. + The targets for the association. You must specify the InstanceId or Targets property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets DuplicatesAllowed: False diff --git a/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 b/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 index 1317ee8de..dafdd2001 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 @@ -13,21 +13,30 @@ function New-VSSSMDocument { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Content - A valid JSON or YAML string. + The content for the new SSM document, in valid JSON or YAML format. +We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. +For examples, see the following topics in the *AWS Systems Manager User Guide*. ++ Create an SSM Document AWS API: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html ++ Create an SSM Document AWS CLI: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html ++ Create an SSM Document Tools for Windows PowerShell: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-ps.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content PrimitiveType: Json UpdateType: Immutable .PARAMETER DocumentType - The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package. + The type of document to create. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype PrimitiveType: String UpdateType: Immutable .PARAMETER Name - + AWS Systems Manager Documents: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html + A name for the Systems Manager document. +Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes: ++ aws ++ amazon ++ amzn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name PrimitiveType: String @@ -120,16 +129,8 @@ function New-VSSSMDocument { } })] $Name, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 index c7ab4f2c3..4d28b4e17 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 @@ -207,16 +207,8 @@ For more information, see Systems Manager Maintenance Windows: https://docs.aws. } })] $EndDate, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 index 7642a90be..10348616d 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 @@ -42,14 +42,7 @@ function New-VSSSMMaintenanceWindowTarget { .PARAMETER Targets The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. -You can specify targets using either instance IDs or tags that have been applied to instances. -**Example 1**: Specify instance IDs -Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 -**Example 2**: Use tag key-pairs applied to instances -Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 -**Example 3**: Use tag-keys applied to instances -Key=tag-key,Values=my-tag-key-1,my-tag-key-2 -For more information about these examples formats, including the best use case for each one, see Examples: Register Targets with a Maintenance Window: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html in the *AWS Systems Manager User Guide*. +You must specify targets by using the WindowTargetIds parameter. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 index 600110705..7a8388a7c 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 @@ -68,7 +68,7 @@ function New-VSSSMMaintenanceWindowTask { The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the SSM document name or Amazon Resource Name ARN. For LAMBDA tasks, TaskArn is the function name or ARN. -For STEP_FUNCTION tasks, TaskArn is the state machine ARN. +For STEP_FUNCTIONS tasks, TaskArn is the state machine ARN. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn PrimitiveType: String @@ -97,7 +97,7 @@ TaskParameters has been deprecated. To specify parameters to pass to a task when UpdateType: Mutable .PARAMETER TaskType - The type of task. Valid values: RUN_COMMAND, AUTOMATION, LAMBDA, STEP_FUNCTION. + The type of task. Valid values: RUN_COMMAND, AUTOMATION, LAMBDA, STEP_FUNCTIONS. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 b/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 index 3967e53d8..1cd018a64 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 @@ -21,8 +21,9 @@ For information about valid values for parameters, see Requirements and Constrai The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Type - The type of parameter. Valid values include the following: String or StringList. -AWS CloudFormation doesn't support the SecureString parameter type. + The type of parameter. +AWS CloudFormation doesn't support creating a SecureString parameter type. +*Allowed Values*: String | StringList Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type PrimitiveType: String @@ -65,8 +66,7 @@ Working with Parameter Policies: https://docs.aws.amazon.com/systems-manager/lat UpdateType: Mutable .PARAMETER Tags - An array of key-value pairs to apply to this resource. -For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html. + Optional metadata that you assign to a resource in the form of an arbitrary set of tags key-value pairs. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 b/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 index b4f059a84..09e48e93b 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 @@ -246,16 +246,8 @@ For information about accepted formats for lists of approved patches and rejecte $ApprovedPatchesEnableNonSecurity, [parameter(Mandatory = $false)] $GlobalFilters, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 b/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 index 27087e921..263ab7c40 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 @@ -1,12 +1,22 @@ function New-VSSSMResourceDataSync { <# .SYNOPSIS - Adds an AWS::SSM::ResourceDataSync resource to the template. The AWS::SSM::ResourceDataSync resource creates or deletes a Resource Data Sync for AWS Systems Manager Inventory. You can use Resource Data Sync to send Inventory data collected from all of your Systems Manager managed instances to a single Amazon S3 bucket that you have already created in your account. Resource Data Sync then automatically updates the centralized data when new Inventory data is collected. + Adds an AWS::SSM::ResourceDataSync resource to the template. The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a Resource Data Sync for AWS Systems Manager. A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. .DESCRIPTION - Adds an AWS::SSM::ResourceDataSync resource to the template. The AWS::SSM::ResourceDataSync resource creates or deletes a Resource Data Sync for AWS Systems Manager Inventory. You can use Resource Data Sync to send Inventory data collected from all of your Systems Manager managed instances to a single Amazon S3 bucket that you have already created in your account. Resource Data Sync then automatically updates the centralized data when new Inventory data is collected. + Adds an AWS::SSM::ResourceDataSync resource to the template. The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a Resource Data Sync for AWS Systems Manager. A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. -For more information, see Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync in the *AWS Systems Manager User Guide*. +You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. + +You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems and operational data (OpsData from multiple AWS Regions. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an EntireOrganization by using AWS Organizations. + +A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. + +By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. + +For more information, see Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync and Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html in the *AWS Systems Manager User Guide*. + +Important: The following *Syntax* section shows all fields that are supported for a resource data sync. The *Examples* section below shows the recommended way to specify configurations for each sync type. Please see the *Examples* section when you create your resource data sync. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html @@ -15,7 +25,7 @@ For more information, see Configuring Inventory Collection: https://docs.aws.ama The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER S3Destination - + Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html + Configuration information for the target Amazon S3 bucket. Type: S3Destination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination @@ -29,7 +39,7 @@ For more information, see Configuring Inventory Collection: https://docs.aws.ama UpdateType: Immutable .PARAMETER SyncSource - + Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html + Information about the source where the data was synchronized. Type: SyncSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource @@ -64,7 +74,7 @@ For more information, see Configuring Inventory Collection: https://docs.aws.ama UpdateType: Immutable .PARAMETER SyncType - + Configuring Inventory Collection: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html + The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an Amazon S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 index fbaadcd8e..b65711e3e 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 @@ -13,6 +13,8 @@ function New-VSSageMakerEndpoint { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER RetainAllVariantProperties + Not supported. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-retainallvariantproperties PrimitiveType: Boolean UpdateType: Mutable @@ -25,6 +27,8 @@ function New-VSSageMakerEndpoint { UpdateType: Immutable .PARAMETER ExcludeRetainedVariantProperties + Not supported. + Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-excluderetainedvariantproperties ItemType: VariantProperty @@ -135,16 +139,8 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm } })] $EndpointConfigName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 index 41262463c..898f7eef1 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 @@ -1,10 +1,10 @@ function New-VSSageMakerEndpointConfig { <# .SYNOPSIS - Adds an AWS::SageMaker::EndpointConfig resource to the template. The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig: https://docs-aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html in the *SageMaker Developer Guide*. + Adds an AWS::SageMaker::EndpointConfig resource to the template. The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html in the *SageMaker Developer Guide*. .DESCRIPTION - Adds an AWS::SageMaker::EndpointConfig resource to the template. The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig: https://docs-aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html in the *SageMaker Developer Guide*. + Adds an AWS::SageMaker::EndpointConfig resource to the template. The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html in the *SageMaker Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html @@ -22,6 +22,15 @@ function New-VSSageMakerEndpointConfig { .PARAMETER KmsKeyId The Amazon Resource Name ARN of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. +The KmsKeyId can be any of the following formats: ++ Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab ++ Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ++ Alias name: alias/ExampleAlias ++ Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias +The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS : https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html +Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails. +For a list of instance types that support local instance storage, see Instance Store Volumes: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes. +For more information about local instance storage encryption, see SSD Instance Store Volumes: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-kmskeyid PrimitiveType: String @@ -121,16 +130,8 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm } })] $EndpointConfigName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 index 427f78d93..3d4f0087e 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 @@ -140,16 +140,8 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm } })] $Containers, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 index 6002531df..6f637948d 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 @@ -280,16 +280,8 @@ You can add tags later by using the CreateTags API. } })] $LifecycleConfigName, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 index fb3d49581..1d604ea7e 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 @@ -132,16 +132,8 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm } })] $MemberDefinitions, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 index 17e612bbe..aba31c2fd 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 @@ -1,10 +1,10 @@ function New-VSSecretsManagerResourcePolicy { <# .SYNOPSIS - Adds an AWS::SecretsManager::ResourcePolicy resource to the template. Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all relevant policies. + Adds an AWS::SecretsManager::ResourcePolicy resource to the template. Attaches the contents of the git specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the Amazon Resource Name (ARN of the secret in the policy statement Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions permitted by all relevant policies. .DESCRIPTION - Adds an AWS::SecretsManager::ResourcePolicy resource to the template. Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all relevant policies. + Adds an AWS::SecretsManager::ResourcePolicy resource to the template. Attaches the contents of the git specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the Amazon Resource Name (ARN of the secret in the policy statement Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions permitted by all relevant policies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html @@ -13,15 +13,15 @@ function New-VSSecretsManagerResourcePolicy { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretId - Specifies the Amazon Resource Name ARN or the friendly name of the secret that you want to attach a resource-based permissions policy to. -If you use this property to change the SecretId for an existing resource-based policy, it removes the policy from the original secret, and then attaches the policy to the secret with the specified SecretId. This results in changing the permissions for two secrets. + Specifies the Amazon Resource Name ARN or the friendly name of the secret to attach a resource-based permissions policy. +If you use this property to change the SecretId for an existing resource-based policy, Secrets Manager removes the policy from the original secret, and then attaches the policy to the secret with the specified SecretId. This results in changing the permissions for two secrets. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-secretid PrimitiveType: String UpdateType: Immutable .PARAMETER ResourcePolicy - Specifies a JSON object that's constructed according to the grammar and syntax for a resource-based policy. The policy identifies who can access or manage this secret and its versions. For information on how to format a JSON object as a parameter for this resource type, see Using Resource-based Policies for Secrets Manager: https://docs.aws.amazon.com/secretsmanager/latest/UserGuide/auth-and-access-resource-based-policies.htmlin the AWS Secrets Manager User Guide. Those same rules apply here. + Specifies a JSON object constructed according to the grammar and syntax for a resource-based policy. The policy identifies who can access or manage this secret and associated versions. For information on how to format a JSON object as a parameter for this resource type, see Using Resource-based Policies for Secrets Manager: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html in the AWS Secrets Manager User Guide. Those same rules apply here. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-resourcepolicy PrimitiveType: Json diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 index 14adb7c46..d7981303f 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 @@ -1,14 +1,14 @@ function New-VSSecretsManagerRotationSchedule { <# .SYNOPSIS - Adds an AWS::SecretsManager::RotationSchedule resource to the template. The AWS::SecretsManager::RotationSchedule resource configures rotation for a secret. The secret must already be configured with the details of the database or service. If you define both the secret and the database or service in an AWS CloudFormation template, then define the AWS::SecretsManager::SecretTargetAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html resource to populate the secret with the connection details of the database or service before you attempt to configure rotation. + Adds an AWS::SecretsManager::RotationSchedule resource to the template. The AWS::SecretsManager::RotationSchedule resource configures rotation for a secret. You must have already configured the secret with the details of the database or service. If you define both the secret and the database or service in an AWS CloudFormation template, then define the AWS::SecretsManager::SecretTargetAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html resource to populate the secret with the connection details of the database or service before you attempt to configure rotation. .DESCRIPTION - Adds an AWS::SecretsManager::RotationSchedule resource to the template. The AWS::SecretsManager::RotationSchedule resource configures rotation for a secret. The secret must already be configured with the details of the database or service. If you define both the secret and the database or service in an AWS CloudFormation template, then define the AWS::SecretsManager::SecretTargetAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html resource to populate the secret with the connection details of the database or service before you attempt to configure rotation. + Adds an AWS::SecretsManager::RotationSchedule resource to the template. The AWS::SecretsManager::RotationSchedule resource configures rotation for a secret. You must have already configured the secret with the details of the database or service. If you define both the secret and the database or service in an AWS CloudFormation template, then define the AWS::SecretsManager::SecretTargetAttachment: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html resource to populate the secret with the connection details of the database or service before you attempt to configure rotation. **Important** -When you configure rotation for a secret, AWS CloudFormation automatically rotates the secret one time. Ensure that you configure all your clients to retrieve the secret using Secrets Manager before configuring rotation to prevent breaking them. +When you configure rotation for a secret, AWS CloudFormation automatically rotates the secret one time. Be sure you configure all your clients to retrieve the secret using Secrets Manager before configuring rotation to prevent breaking them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html @@ -17,14 +17,14 @@ When you configure rotation for a secret, AWS CloudFormation automatically rotat The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretId - Specifies the Amazon Resource Name ARN or the friendly name of the secret that you want to rotate. To reference a secret also that's created in this template, use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the secret's logical ID. + Specifies the ARN or the friendly name of the secret that you want to rotate. To reference a secret also created in this template, use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the secret's logical ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-secretid PrimitiveType: String UpdateType: Immutable .PARAMETER RotationLambdaARN - Specifies the ARN of the Lambda function that can rotate the secret. If you don't specify this parameter, then the secret must already have the ARN of a Lambda function configured. To reference a Lambda function that's also created in this template, use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the function's logical ID. + Specifies the ARN of the Lambda function that can rotate the secret. If you don't specify this parameter, then the secret must already have the ARN of a Lambda function configured. To reference a Lambda function also created in this template, use the Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the function's logical ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationlambdaarn PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 index 5c1fd2bab..94ff8d82b 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 @@ -6,19 +6,19 @@ function New-VSSecretsManagerSecret { .DESCRIPTION Adds an AWS::SecretsManager::Secret resource to the template. The AWS::SecretsManager::Secret resource creates a secret and stores it in Secrets Manager. For more information, see Secret: https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_secret in the *AWS Secrets Manager User Guide*, and the CreateSecret API: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html in the *AWS Secrets Manager API Reference*. -To specify the SecretString encrypted value for the secret, specify either the SecretString or the GenerateSecretString property in this resource. You must specify one or the other, but you can't specify both. See the first two examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-hardcoded later in this topic. +To specify the SecretString encrypted value for the secret, specify either the SecretString or the GenerateSecretString property in this resource. You must specify one or the other, but not both. Leaving both empty creates a secret without a secret version. See the first two examples: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-hardcoded later in this topic. **Note** -You can't generate a secret with a SecretBinary secret value using AWS CloudFormation. You can create only a SecretString text-based secret value. +You can't generate a secret with a SecretBinary secret value using AWS CloudFormation. You can only create a SecretString text-based secret value. **Note** -Do not create a dynamic reference that has a backslash (as the final value. AWS CloudFormation cannot resolve those references, which results in a resource failure. +Do not create a dynamic reference using a backslash ( as the final value. AWS CloudFormation cannot resolve those references, which causes a resource failure. After you create the basic secret, you can do any of the following: -+ Configure your secret with details of the Secrets Manager supported database or service: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html#full-rotation-support whose credentials are stored in this secret. ++ Configure your secret with details of the Secrets Manager supported database or service: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html#full-rotation-support with credentials stored in this secret. + Attach a resource-based permissions policy to the secret. To do this, define a AWS::SecretsManager::ResourcePolicy: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html resource type. @@ -38,8 +38,8 @@ After you create the basic secret, you can do any of the following: UpdateType: Mutable .PARAMETER KmsKeyId - Specifies the ARN, Key ID, or alias of the AWS KMS customer master key CMK that's used to encrypt the SecretString or SecretBinary values for versions of this secret. If you don't specify this value, then Secrets Manager defaults to the AWS account's CMK the one named aws/secretsmanager. If an AWS KMS CMK with that name doesn't yet exist, Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields. -You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field. + Specifies the ARN, Key ID, or alias of the AWS KMS customer master key CMK used to encrypt the SecretString or SecretBinary values for versions of this secret. If you don't specify this value, then Secrets Manager defaults to the AWS account CMK, aws/secretsmanager. If an AWS KMS CMK with that name doesn't exist, Secrets Manager creates the CMK for you automatically the first time it encrypts a version SecretString or SecretBinary fields. +You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-kmskeyid PrimitiveType: String @@ -47,17 +47,17 @@ You can use the account's default CMK to encrypt and decrypt only if you call th .PARAMETER SecretString Specifies a literal string to use as the secret value for the secret. You can use any text you like, but remember that Lambda rotation functions require a specific JSON structure to be present in this field. -Alternatively, instead of hardcoding the password in this string parameter, we recommend that you use the GenerateSecretString parameter instead. +Alternatively, instead of hardcoding the password in this string parameter, we recommend you use the GenerateSecretString parameter instead. You must specify either SecretString or GenerateSecretString, but not both. -Stack updates that modify a SecretString property, will immediately change the secret's value. +Stack updates that modify a SecretString property, immediately changes the secret value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-secretstring PrimitiveType: String UpdateType: Mutable .PARAMETER GenerateSecretString - A structure that specifies how to generate a random password by using the functionality of the GetRandomPassword API: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetRandomPassword.html. You can return that string directly to use as the secret value, or you can specify both the SecretStringTemplate and the GenerateSecretKeyparameters. Secrets Manager uses the value in GenerateSecretKeyparameters. Secrets Manager uses the value in GenerateSecretKey as the key name and combines it with the randomly generated password to make a JSON key-value pair. It then inserts that pair into the JSON structure that's specified in the SecretStringTemplateparameter. Secrets Manager stores the completed string as the secret value in the initial version of the secret. For more information about how to use this property, see Secrets Manager Secret GenerateSecretString: https://docs.aws.amazon.com/AWSCloudFormation/latest/userguide/aws-properties-secretsmanager-secret-generatesecretstring.html and the first example: https://docs.aws.amazon.com/AWSCloudFormation/latest/userguide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-generated in the following Examples section. -Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. + A structure that specifies generating a random password by using the functionality of the GetRandomPassword API: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetRandomPassword.html. You can return that string directly to use as the secret value, or you can specify both the SecretStringTemplate and the GenerateSecretKey parameters. Secrets Manager uses the value in GenerateSecretKey parameters. Secrets Manager uses the value in GenerateSecretKey as the key name and combines it with the randomly generated password to make a JSON key-value pair. Secrets Manager then inserts the pair into the JSON structure specified in the SecretStringTemplate parameter. Secrets Manager stores the completed string as the secret value in the initial version of the secret. For more information about how to use this property, see Secrets Manager Secret GenerateSecretString: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html and the first example: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-generated in the following Examples section. +Either SecretString or GenerateSecretString must have a value, but not both. They cannot both be empty. Type: GenerateSecretString Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-generatesecretstring @@ -158,16 +158,8 @@ Either SecretString or SecretBinary must have a value, but not both. They cannot $SecretString, [parameter(Mandatory = $false)] $GenerateSecretString, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 index 872e5d29c..04d623695 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 @@ -1,16 +1,16 @@ function New-VSSecretsManagerSecretTargetAttachment { <# .SYNOPSIS - Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. The AWS::SecretsManager::SecretTargetAttachmentresource completes the final link between a Secrets Manager secret and its associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order: + Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. The AWS::SecretsManager::SecretTargetAttachment resource completes the final link between a Secrets Manager secret and the associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order: .DESCRIPTION - Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. The AWS::SecretsManager::SecretTargetAttachmentresource completes the final link between a Secrets Manager secret and its associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order: + Adds an AWS::SecretsManager::SecretTargetAttachment resource to the template. The AWS::SecretsManager::SecretTargetAttachment resource completes the final link between a Secrets Manager secret and the associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order: 1. Define the secret without referencing the service or database. You can't reference the service or database because it doesn't exist yet. -1. Next, define the service or database. Include the reference to the secret to use its stored credentials to define the database's master user and password. +1. Next, define the service or database. Include the reference to the secret to use stored credentials to define the database's master user and password. -1. Finally, define a SecretTargetAttachmentresource type to finish configuring the secret with the required database engine type and the connection details of the service or database. These details are required by a rotation function, if one is attached later by defining a AWS::SecretsManager::RotationSchedule : https://docs.aws.amazon.com/AWSCloudFormation/latest/userguide/aws-resource-secretsmanager-rotationschedule.html resource type. +1. Finally, define a SecretTargetAttachment resource type to finish configuring the secret with the required database engine type and the connection details of the service or database. The rotation function requires the details, if you attach one later by defining a AWS::SecretsManager::RotationSchedule : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html resource type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html @@ -19,21 +19,26 @@ function New-VSSecretsManagerSecretTargetAttachment { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER SecretId - The Amazon Resource Name ARN or the friendly name of the secret that contains the credentials that you want to use with the specified service or database. To reference a secret that's also created in this template, use the see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the secret's logical ID. + The Amazon Resource Name ARN or the friendly name of the secret that contains the credentials that you want to use with the specified service or database. To reference a secret also created in this template, use the see Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html function with the secret's logical ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html#cfn-secretsmanager-secrettargetattachment-secretid PrimitiveType: String UpdateType: Mutable .PARAMETER TargetType - A string used by the Secrets Manager console to determine how to parse the structure of the secret text and place the values in the proper fields of the console user interface. If you created this secret using the Secrets Manager console then we recommend that you do not modify this value. If this is a custom secret, then this field is available for your use. As a best practice, do not store any sensitive information in this field. Instead, store sensitive information in the SecretString or SecretBinary fields to ensure that it is encrypted. + A string that defines the type of service or database associated with the secret. This value instructs AWS Secrets Manager how to update the secret with the details of the service or database. This value must be one of the following: ++ AWS::RDS::DBInstance ++ AWS::RDS::DBCluster ++ AWS::Redshift::Cluster ++ AWS::DocDB::DBInstance ++ AWS::DocDB::DBCluster Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html#cfn-secretsmanager-secrettargetattachment-targettype PrimitiveType: String UpdateType: Mutable .PARAMETER TargetId - The ARN of the service or database whose credentials are stored in the specified secret. + The ARN of the service or database credentials stored in the specified secret. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html#cfn-secretsmanager-secrettargetattachment-targetid PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 index fb1b13c17..91a02e237 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 @@ -209,16 +209,8 @@ function New-VSServiceCatalogCloudFormationProduct { } })] $SupportUrl, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 index 508d579b6..bc655ad13 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 @@ -220,16 +220,8 @@ You must specify either the ID or the name of the provisioning artifact, but not } })] $ProductId, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $false)] [ValidateScript( { diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 index ef627ef98..e39acaad6 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 @@ -140,16 +140,8 @@ function New-VSServiceCatalogPortfolio { } })] $AcceptLanguage, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 index a1f73d9a5..d8700a042 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 @@ -50,13 +50,14 @@ If you specify a health check configuration, you can specify either HealthCheckC .PARAMETER NamespaceId The ID of the namespace that was used to create the service. +You must specify a value for NamespaceId either for the service properties or for DnsConfig: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html. Don't specify a value in both places. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-namespaceid PrimitiveType: String UpdateType: Immutable .PARAMETER HealthCheckConfig - *Public DNS namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. + *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. For information about the charges for health checks, see Amazon Route 53 Pricing: http://aws.amazon.com/route53/pricing/. Type: HealthCheckConfig diff --git a/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 b/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 index c48321c0b..f417d336d 100644 --- a/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 @@ -31,6 +31,7 @@ A name must *not* contain: + wildcard characters ? * + special characters " # % ^ | ~ $ & , ; : / + control characters U+0000-001F, U+007F-009F +For an EXPRESS state machine, the name should only contain 0-9, A-Z, a-z, - and _ to enable logging with CloudWatch Logs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-name PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 b/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 index d672ede89..d7d14f124 100644 --- a/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 +++ b/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 @@ -20,6 +20,9 @@ function New-VSStepFunctionsStateMachine { UpdateType: Mutable .PARAMETER LoggingConfiguration + Defines what execution history events are logged and where they are logged. +The loggingConfiguration parameter is only valid when StateMachineType is set to EXPRESS. By default, the level is set to OFF. For more information see Log Levels: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html in the AWS Step Functions User Guide. + Type: LoggingConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration UpdateType: Mutable @@ -32,6 +35,7 @@ A name must *not* contain: + wildcard characters ? * + special characters " # % ^ | ~ $ & , ; : / + control characters U+0000-001F, U+007F-009F +If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename PrimitiveType: String @@ -54,6 +58,8 @@ Tags may only contain Unicode letters, digits, white space, or these symbols: _ UpdateType: Mutable .PARAMETER StateMachineType + Determines whether a STANDARD or EXPRESS state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created. For more information on STANDARD and EXPRESS worklfows, see Standard Versus Express Workflows: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html in the AWS Step Functions Developer Guide. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype PrimitiveType: String UpdateType: Immutable diff --git a/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 b/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 index 832bab887..2986b27ca 100644 --- a/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 @@ -1,10 +1,10 @@ function New-VSTransferServer { <# .SYNOPSIS - Adds an AWS::Transfer::Server resource to the template. Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. + Adds an AWS::Transfer::Server resource to the template. The AWS::Transfer::Server resource instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. .DESCRIPTION - Adds an AWS::Transfer::Server resource to the template. Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. + Adds an AWS::Transfer::Server resource to the template. The AWS::Transfer::Server resource instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html @@ -27,14 +27,15 @@ function New-VSTransferServer { UpdateType: Mutable .PARAMETER EndpointType - The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet. + The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud VPC endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC. +It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses BYO IP included with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointtype PrimitiveType: String UpdateType: Mutable .PARAMETER EndpointDetails - The virtual private cloud VPC endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter. + The virtual private cloud VPC endpoint settings that are configured for your SFTP server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. You VPC's default security groups are automatically assigned to your endpoint. Type: EndpointDetails Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointdetails @@ -137,16 +138,8 @@ function New-VSTransferServer { } })] $IdentityProviderType, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 b/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 index 59fe8c04d..e6ea9b34a 100644 --- a/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 @@ -1,10 +1,10 @@ function New-VSTransferUser { <# .SYNOPSIS - Adds an AWS::Transfer::User resource to the template. Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. + Adds an AWS::Transfer::User resource to the template. The AWS::Transfer::User resource creates a user and associates them with an existing Secure File Transfer Protocol (SFTP server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. .DESCRIPTION - Adds an AWS::Transfer::User resource to the template. Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. + Adds an AWS::Transfer::User resource to the template. The AWS::Transfer::User resource creates a user and associates them with an existing Secure File Transfer Protocol (SFTP server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html @@ -30,14 +30,15 @@ For more information, see AssumeRole: https://docs.aws.amazon.com/STS/latest/API UpdateType: Mutable .PARAMETER HomeDirectory - The landing directory folder for a user when they log in to the server using their SFTP client. An example is /home/username . + The landing directory folder for a user when they log in to the server using their SFTP client. +An example is /home/username. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectory PrimitiveType: String UpdateType: Mutable .PARAMETER HomeDirectoryType - An example UserName is sftp-user-1. + The type of landing directory folder you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorytype PrimitiveType: String @@ -58,7 +59,10 @@ For more information, see AssumeRole: https://docs.aws.amazon.com/STS/latest/API UpdateType: Immutable .PARAMETER HomeDirectoryMappings - An example UserName is sftp-user-1. + Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. +' "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]' +In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory "chroot". To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value. +If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorymappings @@ -214,16 +218,8 @@ For more information, see AssumeRole: https://docs.aws.amazon.com/STS/latest/API } })] $SshPublicKeys, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 index 1f48efe7a..48df99073 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 @@ -1,12 +1,18 @@ function New-VSWAFIPSet { <# .SYNOPSIS - Adds an AWS::WAF::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + Adds an AWS::WAF::IPSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAF::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + Adds an AWS::WAF::IPSet resource to the template. **Note** -To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4 or /24, /32, /48, /56, /64, or /128 (for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + +To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4 or /24, /32, /48, /56, /64, or /128 (for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 index b63b069e6..b28acfb94 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFRegionalGeoMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::GeoMatchSet resource to the template. Contains one or more countries that AWS WAF will search for. + Adds an AWS::WAFRegional::GeoMatchSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFRegional::GeoMatchSet resource to the template. Contains one or more countries that AWS WAF will search for. + Adds an AWS::WAFRegional::GeoMatchSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +Contains one or more countries that AWS WAF will search for. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 index 7de28347c..b13326e71 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 @@ -1,12 +1,18 @@ function New-VSWAFRegionalIPSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + Adds an AWS::WAFRegional::IPSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFRegional::IPSet resource to the template. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + Adds an AWS::WAFRegional::IPSet resource to the template. **Note** -To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4 or /24, /32, /48, /56, /64, or /128 (for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. + +To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4 or /24, /32, /48, /56, /64, or /128 (for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 index 7e6dfd4a4..0b1edefa9 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 @@ -14,6 +14,8 @@ In the rule, you also define the rate limit as 15,000. Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count, which is defined in the web ACL. +Note you can only create rate-based rules using a CloudFormation template. To add the rate-based rules created through CloudFormation to a web ACL, use the AWS WAF console, API, or command line interface (CLI. For more information, see UpdateWebACL: https://docs.aws.amazon.com/waf/latest/APIReference/API_regional_UpdateWebACL.html. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 index bb3c54e41..7bde91bcb 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 @@ -6,6 +6,8 @@ function New-VSWAFRegionalRegexPatternSet { .DESCRIPTION Adds an AWS::WAFRegional::RegexPatternSet resource to the template. The RegexPatternSet specifies the regular expression (regex pattern that you want AWS WAF to search for, such as Ba@]dBo0]t. You can then configure AWS WAF to reject those requests. +Note that you can only create regex pattern sets using a CloudFormation template. To add the regex pattern sets created through CloudFormation to a RegexMatchSet, use the AWS WAF console, API, or command line interface (CLI. For more information, see UpdateRegexMatchSet: https://docs.aws.amazon.com/waf/latest/APIReference/API_regional_UpdateRegexMatchSet.html. + .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 index 1114d61a4..b276194d0 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFRegionalSizeConstraintSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. + Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. + Adds an AWS::WAFRegional::SizeConstraintSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 index acd5a4e80..877cb6283 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFRegionalSqlInjectionMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAFRegional::SqlInjectionMatchSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 index 21f2bd2ea..e1fa8f679 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFRegionalXssMatchSet { <# .SYNOPSIS - Adds an AWS::WAFRegional::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAFRegional::XssMatchSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFRegional::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAFRegional::XssMatchSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 index c2b16a70e..7b1d7e354 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFSizeConstraintSet { <# .SYNOPSIS - Adds an AWS::WAF::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. + Adds an AWS::WAF::SizeConstraintSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAF::SizeConstraintSet resource to the template. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. + Adds an AWS::WAF::SizeConstraintSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 index dbc78ff93..b8f1e11af 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFSqlInjectionMatchSet { <# .SYNOPSIS - Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAF::SqlInjectionMatchSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 index fec43f65e..7663a573d 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFXssMatchSet { <# .SYNOPSIS - Adds an AWS::WAF::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAF::XssMatchSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAF::XssMatchSet resource to the template. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. + Adds an AWS::WAF::XssMatchSet resource to the template. **Note** + +This is **AWS WAF Classic** documentation. For more information, see AWS WAF Classic: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html in the developer guide. + +**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. With the latest version, AWS WAF has a single set of endpoints for regional and global use. + +A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 index 4ef0e21f4..171182c93 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFv2IPSet { <# .SYNOPSIS - Adds an AWS::WAFv2::IPSet resource to the template. + Adds an AWS::WAFv2::IPSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFv2::IPSet resource to the template. + Adds an AWS::WAFv2::IPSet resource to the template. **Note** + +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +The AWS::WAFv2::IPSet is used to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IP set that lists those IP addresses. + +You use an IP set by providing its Amazon Resource Name (ARN to the rule statement IPSetReferenceStatement, when you add a rule to a rule group or web ACL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html @@ -13,32 +19,50 @@ function New-VSWAFv2IPSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A friendly description of the IP set. You cannot change the description of an IP set after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name + A friendly name of the IP set. You cannot change the name of an IPSet after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-name UpdateType: Mutable PrimitiveType: String .PARAMETER Scope + Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-scope UpdateType: Mutable PrimitiveType: String .PARAMETER IPAddressVersion + Specify IPV4 or IPV6. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-ipaddressversion UpdateType: Mutable PrimitiveType: String .PARAMETER Addresses + Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing CIDR notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6. +Examples: ++ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. ++ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. ++ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. ++ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. +For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-addresses UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Tags + Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-tags UpdateType: Mutable Type: List @@ -135,16 +159,8 @@ function New-VSWAFv2IPSet { $IPAddressVersion, [parameter(Mandatory = $true)] $Addresses, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 index ce1e77783..4ac05db04 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 @@ -1,10 +1,16 @@ function New-VSWAFv2RegexPatternSet { <# .SYNOPSIS - Adds an AWS::WAFv2::RegexPatternSet resource to the template. + Adds an AWS::WAFv2::RegexPatternSet resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFv2::RegexPatternSet resource to the template. + Adds an AWS::WAFv2::RegexPatternSet resource to the template. **Note** + +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Use an AWS::WAFv2::RegexPatternSet: #aws-resource-wafv2-regexpatternset to have AWS WAF inspect a web request component for a specific set of regex patterns. + +You use a regex pattern set by providing its Amazon Resource Name (ARN to the rule statement RegexPatternSetReferenceStatement, when you add a rule to a rule group or web ACL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html @@ -13,27 +19,37 @@ function New-VSWAFv2RegexPatternSet { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description + A friendly description of the set. You cannot change the description of a set after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name + A friendly name of the set. You cannot change the name after you create the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-name UpdateType: Mutable PrimitiveType: String .PARAMETER RegularExpressionList + The regular expression patterns in the set. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-regularexpressionlist UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Scope + Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Tags + Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-tags UpdateType: Mutable Type: List @@ -119,16 +135,8 @@ function New-VSWAFv2RegexPatternSet { } })] $Scope, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 index eabc9a104..dd43aef72 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 @@ -1,10 +1,16 @@ function New-VSWAFv2RuleGroup { <# .SYNOPSIS - Adds an AWS::WAFv2::RuleGroup resource to the template. + Adds an AWS::WAFv2::RuleGroup resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFv2::RuleGroup resource to the template. + Adds an AWS::WAFv2::RuleGroup resource to the template. **Note** + +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Use an AWS::WAFv2::RuleGroup: #aws-resource-wafv2-rulegroup to define a collection of rules for inspecting and controlling web requests. You use a rule group in an AWS::WAFv2::WebACL: aws-resource-wafv2-webacl.md by providing its Amazon Resource Name (ARN to the rule statement RuleGroupReferenceStatement, when you add rules to the web ACL. + +When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html @@ -13,37 +19,53 @@ function New-VSWAFv2RuleGroup { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Capacity + The web ACL capacity units WCUs required for this rule group. +When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity. +AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-capacity UpdateType: Mutable PrimitiveType: Integer .PARAMETER Description + A friendly description of the rule group. You cannot change the description of a rule group after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name + A friendly name of the rule group. You cannot change the name of a rule group after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-name UpdateType: Mutable PrimitiveType: String .PARAMETER Scope + Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Rules + The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-rules UpdateType: Mutable Type: List ItemType: Rule .PARAMETER VisibilityConfig + Defines and enables Amazon CloudWatch metrics and web request sample collection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-visibilityconfig UpdateType: Mutable Type: VisibilityConfig .PARAMETER Tags + Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-tags UpdateType: Mutable Type: List @@ -151,16 +173,8 @@ function New-VSWAFv2RuleGroup { $Rules, [parameter(Mandatory = $true)] $VisibilityConfig, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 index ee992415f..38c5fc767 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 @@ -1,10 +1,14 @@ function New-VSWAFv2WebACL { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACL resource to the template. + Adds an AWS::WAFv2::WebACL resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFv2::WebACL resource to the template. + Adds an AWS::WAFv2::WebACL resource to the template. **Note** + +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Use an AWS::WAFv2::WebACL: #aws-resource-wafv2-webacl to define a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block for any request that does not match any of the rules. The rules in a web ACL can contain rule statements that you define explicitly and rule statements that reference rule groups and managed rule groups. You can associate a web ACL with one or more AWS resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway API, or an Application Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html @@ -13,37 +17,51 @@ function New-VSWAFv2WebACL { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DefaultAction + The action to perform if none of the Rules contained in the WebACL match. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-defaultaction UpdateType: Mutable Type: DefaultAction .PARAMETER Description + A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name + A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-name UpdateType: Mutable PrimitiveType: String .PARAMETER Scope + Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Rules + The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-rules UpdateType: Mutable Type: List ItemType: Rule .PARAMETER VisibilityConfig + Defines and enables Amazon CloudWatch metrics and web request sample collection. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-visibilityconfig UpdateType: Mutable Type: VisibilityConfig .PARAMETER Tags + Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tags UpdateType: Mutable Type: List @@ -142,16 +160,8 @@ function New-VSWAFv2WebACL { $Rules, [parameter(Mandatory = $true)] $VisibilityConfig, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [ValidateSet("Delete","Retain","Snapshot")] [System.String] diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 index a1cd93d5f..be67d4b49 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 @@ -1,10 +1,16 @@ function New-VSWAFv2WebACLAssociation { <# .SYNOPSIS - Adds an AWS::WAFv2::WebACLAssociation resource to the template. + Adds an AWS::WAFv2::WebACLAssociation resource to the template. **Note** .DESCRIPTION - Adds an AWS::WAFv2::WebACLAssociation resource to the template. + Adds an AWS::WAFv2::WebACLAssociation resource to the template. **Note** + +This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. + +Use a web ACL association to define an association between a Web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB or an API Gateway stage. + +For AWS CloudFront, don't use this resource. Instead, use your CloudFront distribution configuration. To associate a Web ACL with a distribution, provide the Amazon Resource Name (ARN of the AWS::WAFv2::WebACL: aws-resource-wafv2-webacl.md to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html @@ -13,11 +19,18 @@ function New-VSWAFv2WebACLAssociation { The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResourceArn + The Amazon Resource Name ARN of the resource to associate with the web ACL. +The ARN must be in one of the following formats: ++ For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ++ For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-resourcearn UpdateType: Mutable PrimitiveType: String .PARAMETER WebACLArn + The Amazon Resource Name ARN of the Web ACL that you want to associate with the resource. + Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-webaclarn UpdateType: Mutable PrimitiveType: String diff --git a/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 b/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 index da8ff19f8..b6b2fa73e 100644 --- a/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 @@ -45,7 +45,7 @@ Updates are not supported for the BundleId, RootVolumeEncryptionEnabled, UserVol UpdateType: Mutable .PARAMETER UserName - The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace. + The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-username PrimitiveType: String @@ -59,7 +59,7 @@ Updates are not supported for the BundleId, RootVolumeEncryptionEnabled, UserVol UpdateType: Conditional .PARAMETER VolumeEncryptionKey - The KMS key used to encrypt data stored on your WorkSpace. + The symmetric AWS KMS customer master key CMK used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-volumeencryptionkey PrimitiveType: String @@ -150,16 +150,8 @@ Updates are not supported for the BundleId, RootVolumeEncryptionEnabled, UserVol } })] $RootVolumeEncryptionEnabled, + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $false)] - [ValidateScript( { - $allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { - $true - } - else { - $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) - } - })] $Tags, [parameter(Mandatory = $true)] [ValidateScript( { diff --git a/VaporShell/bin/TransformTag.cs b/VaporShell/bin/TransformTag.cs deleted file mode 100644 index 0ee6cf5f8..000000000 --- a/VaporShell/bin/TransformTag.cs +++ /dev/null @@ -1,77 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.Management.Automation; - -public class TransformTagAttribute : ArgumentTransformationAttribute { - private EngineIntrinsics engineIntrinsics; - - private IEnumerable InvokeAddVSTag(object key, object value) - { - var tags = this.engineIntrinsics.InvokeCommand.InvokeScript( - String.Format("Add-VSTag -Key '{0}' -Value '{1}'", key, value) - ); - - foreach (PSObject tag in tags) - { - yield return tag; - } - } - - private IEnumerable TransformHashtable(IDictionary inputData) - { - foreach (string key in inputData.Keys) - { - foreach (PSObject tag in this.InvokeAddVSTag(key, inputData[key])) - { - yield return tag; - } - } - } - - private IEnumerable TransformPSObject(PSObject inputData) - { - foreach (var property in inputData.Properties) - { - foreach (PSObject tag in this.InvokeAddVSTag(property.Name, property.Value)) - { - yield return tag; - } - } - } - - private object TransformData(object inputData) - { - if (inputData is Array) - { - foreach (object item in inputData as object[]) - { - return this.TransformData(item); - } - } - else if (inputData is IDictionary) - { - return this.TransformHashtable(inputData as IDictionary); - } - else if (inputData is PSObject) - { - PSObject psObject = inputData as PSObject; - if (psObject.TypeNames.Contains("Vaporshell.Resource.Tag")) - { - return inputData; - } - else if (psObject.TypeNames.Contains("System.Management.Automation.PSCustomObject")) - { - return this.TransformPSObject(psObject); - } - } - - return inputData; - } - - public override object Transform(EngineIntrinsics engineIntrinsics, object inputData) - { - this.engineIntrinsics = engineIntrinsics; - return this.TransformData(inputData); - } -} diff --git a/ci/Convert-SpecToFunction.ps1 b/ci/Convert-SpecToFunction.ps1 index 753331556..e6444f1c4 100644 --- a/ci/Convert-SpecToFunction.ps1 +++ b/ci/Convert-SpecToFunction.ps1 @@ -166,19 +166,11 @@ function $FunctionName { else { $Mandatory = '$false' } - if ($Prop.Value.ItemType) { + if ($Prop.Value.ItemType) {bld if ($Prop.Value.ItemType -eq "Tag") { $scriptContents += @" + [VaporShell.Core.TransformTag()] [parameter(Mandatory = $Mandatory)] - [ValidateScript( { - `$allowedTypes = "Vaporshell.Resource.Tag","System.Management.Automation.PSCustomObject" - if ([string]`$(`$_.PSTypeNames) -match "(`$((`$allowedTypes|ForEach-Object{[RegEx]::Escape(`$_)}) -join '|'))") { - `$true - } - else { - `$PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: `$(`$allowedTypes -join ", "). The current types of the value are: `$(`$_.PSTypeNames -join ", ").")) - } - })] `$$ParamName "@ } @@ -350,6 +342,9 @@ function $FunctionName { [ValidateSet("Delete","Retain","Snapshot")] [System.String] `$DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + `$UpdateReplacePolicy, [parameter(Mandatory = `$false)] [System.String[]] `$DependsOn, diff --git a/ci/aws-cloudformation-user-guide b/ci/aws-cloudformation-user-guide index 586817c58..8a1579217 160000 --- a/ci/aws-cloudformation-user-guide +++ b/ci/aws-cloudformation-user-guide @@ -1 +1 @@ -Subproject commit 586817c5846fa7ecd2b776d5bf0d352558e1ce5e +Subproject commit 8a1579217f36a031dcc0e2d5717fa0a6ff459d46 diff --git a/invoke.build.ps1 b/invoke.build.ps1 index 38ab0f8c4..eb27d3299 100644 --- a/invoke.build.ps1 +++ b/invoke.build.ps1 @@ -111,6 +111,9 @@ Task Build Update, { ' $ForceDotSource = $false' ')' '$VaporshellPath = $PSScriptRoot' + 'if ($null -eq ([System.AppDomain]::CurrentDomain.GetAssemblies() | Where-Object {$_.Location -match "VaporShell.Core.dll"})) {' + ' Add-Type -Path "$VaporshellPath\VaporShell.Core.dll" -ReferencedAssemblies ([PowerShell].Assembly.Location)' + '}' ) -join "`n" $psm1Header | Add-Content -Path $psm1 -Encoding UTF8 @@ -143,6 +146,10 @@ Task Build Update, { ([System.IO.File]::ReadAllText($SourceManifestPath)).Trim() | Set-Content $SourceManifestPath } + Write-BuildLog 'Compiling VaporShell.Core.dll' + dotnet build .\VaporShell.Core\ + Get-Item ".\VaporShell.Core\obj\Debug\netstandard2.0\VaporShell.Core.dll" | Copy-Item -Destination $TargetVersionDirectory -Recurse -ErrorAction SilentlyContinue + Write-BuildLog 'Copying latest AWSSDK assembly dependencies to output path' Save-Module 'AWS.Tools.CloudFormation','AWS.Tools.S3' -Path $PSScriptRoot -Repository PSGallery -Force Get-Item 'AWS.Tools.*' | ForEach-Object { From 32c49318b047846abff8a0ab14bb2398d6e99134 Mon Sep 17 00:00:00 2001 From: Nate Ferrell Date: Wed, 4 Mar 2020 03:06:50 -0600 Subject: [PATCH 4/6] saving current progress --- VaporShell.Core.dll | Bin 0 -> 11776 bytes VaporShell.Core/VaporShell.Core.cs | 29 ++++++++++-------- .../Public/Intrinsic Functions/Add-FnCidr.ps1 | 0 .../Intrinsic Functions/Add-FnTransform.ps1 | 0 .../New-VSACMPCACertificate.ps1 | 3 ++ .../New-VSACMPCACertificateAuthority.ps1 | 3 ++ ...VSACMPCACertificateAuthorityActivation.ps1 | 3 ++ .../New-VSAccessAnalyzerAnalyzer.ps1 | 3 ++ .../Resource Types/New-VSAmazonMQBroker.ps1 | 3 ++ .../New-VSAmazonMQConfiguration.ps1 | 3 ++ ...New-VSAmazonMQConfigurationAssociation.ps1 | 3 ++ .../Resource Types/New-VSAmplifyApp.ps1 | 3 ++ .../Resource Types/New-VSAmplifyBranch.ps1 | 3 ++ .../Resource Types/New-VSAmplifyDomain.ps1 | 3 ++ .../New-VSApiGatewayAccount.ps1 | 3 ++ .../Resource Types/New-VSApiGatewayApiKey.ps1 | 3 ++ .../New-VSApiGatewayAuthorizer.ps1 | 3 ++ .../New-VSApiGatewayBasePathMapping.ps1 | 3 ++ .../New-VSApiGatewayClientCertificate.ps1 | 3 ++ .../New-VSApiGatewayDeployment.ps1 | 3 ++ .../New-VSApiGatewayDocumentationPart.ps1 | 3 ++ .../New-VSApiGatewayDocumentationVersion.ps1 | 3 ++ .../New-VSApiGatewayDomainName.ps1 | 3 ++ .../New-VSApiGatewayGatewayResponse.ps1 | 3 ++ .../Resource Types/New-VSApiGatewayMethod.ps1 | 3 ++ .../Resource Types/New-VSApiGatewayModel.ps1 | 3 ++ .../New-VSApiGatewayRequestValidator.ps1 | 3 ++ .../New-VSApiGatewayResource.ps1 | 3 ++ .../New-VSApiGatewayRestApi.ps1 | 3 ++ .../Resource Types/New-VSApiGatewayStage.ps1 | 3 ++ .../New-VSApiGatewayUsagePlan.ps1 | 3 ++ .../New-VSApiGatewayUsagePlanKey.ps1 | 3 ++ .../Resource Types/New-VSApiGatewayV2Api.ps1 | 3 ++ .../New-VSApiGatewayV2ApiMapping.ps1 | 3 ++ .../New-VSApiGatewayV2Authorizer.ps1 | 3 ++ .../New-VSApiGatewayV2Deployment.ps1 | 3 ++ .../New-VSApiGatewayV2DomainName.ps1 | 3 ++ .../New-VSApiGatewayV2Integration.ps1 | 3 ++ .../New-VSApiGatewayV2IntegrationResponse.ps1 | 3 ++ .../New-VSApiGatewayV2Model.ps1 | 3 ++ .../New-VSApiGatewayV2Route.ps1 | 3 ++ .../New-VSApiGatewayV2RouteResponse.ps1 | 3 ++ .../New-VSApiGatewayV2Stage.ps1 | 3 ++ .../New-VSApiGatewayVpcLink.ps1 | 3 ++ .../New-VSAppConfigApplication.ps1 | 3 ++ .../New-VSAppConfigConfigurationProfile.ps1 | 3 ++ .../New-VSAppConfigDeployment.ps1 | 3 ++ .../New-VSAppConfigDeploymentStrategy.ps1 | 3 ++ .../New-VSAppConfigEnvironment.ps1 | 3 ++ .../Resource Types/New-VSAppMeshMesh.ps1 | 3 ++ .../Resource Types/New-VSAppMeshRoute.ps1 | 3 ++ .../New-VSAppMeshVirtualNode.ps1 | 3 ++ .../New-VSAppMeshVirtualRouter.ps1 | 3 ++ .../New-VSAppMeshVirtualService.ps1 | 3 ++ .../New-VSAppStreamDirectoryConfig.ps1 | 3 ++ .../Resource Types/New-VSAppStreamFleet.ps1 | 3 ++ .../New-VSAppStreamImageBuilder.ps1 | 3 ++ .../Resource Types/New-VSAppStreamStack.ps1 | 3 ++ .../New-VSAppStreamStackFleetAssociation.ps1 | 3 ++ .../New-VSAppStreamStackUserAssociation.ps1 | 3 ++ .../Resource Types/New-VSAppStreamUser.ps1 | 3 ++ .../Resource Types/New-VSAppSyncApiCache.ps1 | 3 ++ .../Resource Types/New-VSAppSyncApiKey.ps1 | 3 ++ .../New-VSAppSyncDataSource.ps1 | 3 ++ .../New-VSAppSyncFunctionConfiguration.ps1 | 3 ++ .../New-VSAppSyncGraphQLApi.ps1 | 3 ++ .../New-VSAppSyncGraphQLSchema.ps1 | 3 ++ .../Resource Types/New-VSAppSyncResolver.ps1 | 3 ++ ...VSApplicationAutoScalingScalableTarget.ps1 | 3 ++ ...-VSApplicationAutoScalingScalingPolicy.ps1 | 3 ++ .../Resource Types/New-VSAthenaNamedQuery.ps1 | 3 ++ .../New-VSAutoScalingAutoScalingGroup.ps1 | 3 ++ .../New-VSAutoScalingLaunchConfiguration.ps1 | 3 ++ .../New-VSAutoScalingLifecycleHook.ps1 | 3 ++ .../New-VSAutoScalingPlansScalingPlan.ps1 | 3 ++ .../New-VSAutoScalingScalingPolicy.ps1 | 3 ++ .../New-VSAutoScalingScheduledAction.ps1 | 3 ++ .../Resource Types/New-VSBackupBackupPlan.ps1 | 3 ++ .../New-VSBackupBackupSelection.ps1 | 3 ++ .../New-VSBackupBackupVault.ps1 | 3 ++ .../New-VSBatchComputeEnvironment.ps1 | 3 ++ .../New-VSBatchJobDefinition.ps1 | 3 ++ .../Resource Types/New-VSBatchJobQueue.ps1 | 3 ++ .../Resource Types/New-VSBudgetsBudget.ps1 | 3 ++ .../New-VSCertificateManagerCertificate.ps1 | 3 ++ .../New-VSCloud9EnvironmentEC2.ps1 | 3 ++ .../New-VSCloudFormationCustomResource.ps1 | 3 ++ .../New-VSCloudFormationMacro.ps1 | 3 ++ .../New-VSCloudFormationStack.ps1 | 3 ++ .../New-VSCloudFormationWaitCondition.ps1 | 3 ++ ...ew-VSCloudFormationWaitConditionHandle.ps1 | 3 ++ ...oudFrontCloudFrontOriginAccessIdentity.ps1 | 3 ++ .../New-VSCloudFrontDistribution.ps1 | 3 ++ .../New-VSCloudFrontStreamingDistribution.ps1 | 3 ++ .../Resource Types/New-VSCloudTrailTrail.ps1 | 3 ++ .../Resource Types/New-VSCloudWatchAlarm.ps1 | 3 ++ .../New-VSCloudWatchAnomalyDetector.ps1 | 3 ++ .../New-VSCloudWatchCompositeAlarm.ps1 | 3 ++ .../New-VSCloudWatchDashboard.ps1 | 3 ++ .../New-VSCloudWatchInsightRule.ps1 | 3 ++ .../Resource Types/New-VSCodeBuildProject.ps1 | 3 ++ .../New-VSCodeBuildReportGroup.ps1 | 3 ++ .../New-VSCodeBuildSourceCredential.ps1 | 3 ++ .../New-VSCodeCommitRepository.ps1 | 3 ++ .../New-VSCodeDeployApplication.ps1 | 3 ++ .../New-VSCodeDeployDeploymentConfig.ps1 | 3 ++ .../New-VSCodeDeployDeploymentGroup.ps1 | 3 ++ .../New-VSCodePipelineCustomActionType.ps1 | 3 ++ .../New-VSCodePipelinePipeline.ps1 | 3 ++ .../New-VSCodePipelineWebhook.ps1 | 3 ++ .../New-VSCodeStarGitHubRepository.ps1 | 3 ++ ...SCodeStarNotificationsNotificationRule.ps1 | 3 ++ .../New-VSCognitoIdentityPool.ps1 | 3 ++ ...ew-VSCognitoIdentityPoolRoleAttachment.ps1 | 3 ++ .../Resource Types/New-VSCognitoUserPool.ps1 | 3 ++ .../New-VSCognitoUserPoolClient.ps1 | 3 ++ .../New-VSCognitoUserPoolDomain.ps1 | 3 ++ .../New-VSCognitoUserPoolGroup.ps1 | 3 ++ .../New-VSCognitoUserPoolIdentityProvider.ps1 | 3 ++ .../New-VSCognitoUserPoolResourceServer.ps1 | 3 ++ ...itoUserPoolRiskConfigurationAttachment.ps1 | 3 ++ ...gnitoUserPoolUICustomizationAttachment.ps1 | 3 ++ .../New-VSCognitoUserPoolUser.ps1 | 3 ++ ...VSCognitoUserPoolUserToGroupAttachment.ps1 | 3 ++ .../New-VSConfigAggregationAuthorization.ps1 | 3 ++ .../Resource Types/New-VSConfigConfigRule.ps1 | 3 ++ .../New-VSConfigConfigurationAggregator.ps1 | 3 ++ .../New-VSConfigConfigurationRecorder.ps1 | 3 ++ .../New-VSConfigConformancePack.ps1 | 3 ++ .../New-VSConfigDeliveryChannel.ps1 | 3 ++ .../New-VSConfigOrganizationConfigRule.ps1 | 3 ++ ...ew-VSConfigOrganizationConformancePack.ps1 | 3 ++ .../New-VSConfigRemediationConfiguration.ps1 | 3 ++ .../Resource Types/New-VSDAXCluster.ps1 | 3 ++ .../New-VSDAXParameterGroup.ps1 | 3 ++ .../Resource Types/New-VSDAXSubnetGroup.ps1 | 3 ++ .../New-VSDLMLifecyclePolicy.ps1 | 3 ++ .../Resource Types/New-VSDMSCertificate.ps1 | 3 ++ .../Resource Types/New-VSDMSEndpoint.ps1 | 3 ++ .../New-VSDMSEventSubscription.ps1 | 3 ++ .../New-VSDMSReplicationInstance.ps1 | 3 ++ .../New-VSDMSReplicationSubnetGroup.ps1 | 3 ++ .../New-VSDMSReplicationTask.ps1 | 3 ++ .../New-VSDataPipelinePipeline.ps1 | 3 ++ .../New-VSDirectoryServiceMicrosoftAD.ps1 | 3 ++ .../New-VSDirectoryServiceSimpleAD.ps1 | 3 ++ .../Resource Types/New-VSDocDBDBCluster.ps1 | 3 ++ .../New-VSDocDBDBClusterParameterGroup.ps1 | 3 ++ .../Resource Types/New-VSDocDBDBInstance.ps1 | 3 ++ .../New-VSDocDBDBSubnetGroup.ps1 | 3 ++ .../Resource Types/New-VSDynamoDBTable.ps1 | 3 ++ .../New-VSEC2CapacityReservation.ps1 | 3 ++ .../New-VSEC2ClientVpnAuthorizationRule.ps1 | 3 ++ .../New-VSEC2ClientVpnEndpoint.ps1 | 3 ++ .../New-VSEC2ClientVpnRoute.ps1 | 3 ++ ...VSEC2ClientVpnTargetNetworkAssociation.ps1 | 3 ++ .../New-VSEC2CustomerGateway.ps1 | 3 ++ .../Resource Types/New-VSEC2DHCPOptions.ps1 | 3 ++ .../Resource Types/New-VSEC2EC2Fleet.ps1 | 3 ++ .../Public/Resource Types/New-VSEC2EIP.ps1 | 3 ++ .../New-VSEC2EIPAssociation.ps1 | 3 ++ .../New-VSEC2EgressOnlyInternetGateway.ps1 | 3 ++ .../Resource Types/New-VSEC2FlowLog.ps1 | 3 ++ .../New-VSEC2GatewayRouteTableAssociation.ps1 | 3 ++ .../Public/Resource Types/New-VSEC2Host.ps1 | 3 ++ .../Resource Types/New-VSEC2Instance.ps1 | 3 ++ .../New-VSEC2InternetGateway.ps1 | 3 ++ .../New-VSEC2LaunchTemplate.ps1 | 3 ++ .../New-VSEC2LocalGatewayRoute.ps1 | 3 ++ ...C2LocalGatewayRouteTableVPCAssociation.ps1 | 3 ++ .../Resource Types/New-VSEC2NatGateway.ps1 | 3 ++ .../Resource Types/New-VSEC2NetworkAcl.ps1 | 3 ++ .../New-VSEC2NetworkAclEntry.ps1 | 3 ++ .../New-VSEC2NetworkInterface.ps1 | 3 ++ .../New-VSEC2NetworkInterfaceAttachment.ps1 | 3 ++ .../New-VSEC2NetworkInterfacePermission.ps1 | 3 ++ .../New-VSEC2PlacementGroup.ps1 | 3 ++ .../Public/Resource Types/New-VSEC2Route.ps1 | 3 ++ .../Resource Types/New-VSEC2RouteTable.ps1 | 3 ++ .../Resource Types/New-VSEC2SecurityGroup.ps1 | 3 ++ .../New-VSEC2SecurityGroupEgress.ps1 | 3 ++ .../New-VSEC2SecurityGroupIngress.ps1 | 3 ++ .../Resource Types/New-VSEC2SpotFleet.ps1 | 3 ++ .../Public/Resource Types/New-VSEC2Subnet.ps1 | 3 ++ .../New-VSEC2SubnetCidrBlock.ps1 | 3 ++ .../New-VSEC2SubnetNetworkAclAssociation.ps1 | 3 ++ .../New-VSEC2SubnetRouteTableAssociation.ps1 | 3 ++ .../New-VSEC2TrafficMirrorFilter.ps1 | 3 ++ .../New-VSEC2TrafficMirrorFilterRule.ps1 | 3 ++ .../New-VSEC2TrafficMirrorSession.ps1 | 3 ++ .../New-VSEC2TrafficMirrorTarget.ps1 | 3 ++ .../New-VSEC2TransitGateway.ps1 | 3 ++ .../New-VSEC2TransitGatewayAttachment.ps1 | 3 ++ .../New-VSEC2TransitGatewayRoute.ps1 | 3 ++ .../New-VSEC2TransitGatewayRouteTable.ps1 | 3 ++ ...EC2TransitGatewayRouteTableAssociation.ps1 | 3 ++ ...EC2TransitGatewayRouteTablePropagation.ps1 | 3 ++ .../Public/Resource Types/New-VSEC2VPC.ps1 | 3 ++ .../Resource Types/New-VSEC2VPCCidrBlock.ps1 | 3 ++ .../New-VSEC2VPCDHCPOptionsAssociation.ps1 | 3 ++ .../Resource Types/New-VSEC2VPCEndpoint.ps1 | 3 ++ ...VSEC2VPCEndpointConnectionNotification.ps1 | 3 ++ .../New-VSEC2VPCEndpointService.ps1 | 3 ++ ...New-VSEC2VPCEndpointServicePermissions.ps1 | 3 ++ .../New-VSEC2VPCGatewayAttachment.ps1 | 3 ++ .../New-VSEC2VPCPeeringConnection.ps1 | 3 ++ .../Resource Types/New-VSEC2VPNConnection.ps1 | 3 ++ .../New-VSEC2VPNConnectionRoute.ps1 | 3 ++ .../Resource Types/New-VSEC2VPNGateway.ps1 | 3 ++ .../New-VSEC2VPNGatewayRoutePropagation.ps1 | 3 ++ .../Public/Resource Types/New-VSEC2Volume.ps1 | 3 ++ .../New-VSEC2VolumeAttachment.ps1 | 3 ++ .../Resource Types/New-VSECRRepository.ps1 | 3 ++ .../Resource Types/New-VSECSCluster.ps1 | 3 ++ .../New-VSECSPrimaryTaskSet.ps1 | 3 ++ .../Resource Types/New-VSECSService.ps1 | 3 ++ .../New-VSECSTaskDefinition.ps1 | 3 ++ .../Resource Types/New-VSECSTaskSet.ps1 | 3 ++ .../Resource Types/New-VSEFSFileSystem.ps1 | 3 ++ .../Resource Types/New-VSEFSMountTarget.ps1 | 3 ++ .../Resource Types/New-VSEKSCluster.ps1 | 3 ++ .../Resource Types/New-VSEKSNodegroup.ps1 | 3 ++ .../Resource Types/New-VSEMRCluster.ps1 | 3 ++ .../New-VSEMRInstanceFleetConfig.ps1 | 3 ++ .../New-VSEMRInstanceGroupConfig.ps1 | 3 ++ .../New-VSEMRSecurityConfiguration.ps1 | 3 ++ .../Public/Resource Types/New-VSEMRStep.ps1 | 3 ++ .../New-VSElastiCacheCacheCluster.ps1 | 3 ++ .../New-VSElastiCacheParameterGroup.ps1 | 3 ++ .../New-VSElastiCacheReplicationGroup.ps1 | 3 ++ .../New-VSElastiCacheSecurityGroup.ps1 | 3 ++ .../New-VSElastiCacheSecurityGroupIngress.ps1 | 3 ++ .../New-VSElastiCacheSubnetGroup.ps1 | 3 ++ .../New-VSElasticBeanstalkApplication.ps1 | 3 ++ ...w-VSElasticBeanstalkApplicationVersion.ps1 | 3 ++ ...SElasticBeanstalkConfigurationTemplate.ps1 | 3 ++ .../New-VSElasticBeanstalkEnvironment.ps1 | 3 ++ ...New-VSElasticLoadBalancingLoadBalancer.ps1 | 3 ++ .../New-VSElasticLoadBalancingV2Listener.ps1 | 3 ++ ...sticLoadBalancingV2ListenerCertificate.ps1 | 3 ++ ...w-VSElasticLoadBalancingV2ListenerRule.ps1 | 3 ++ ...w-VSElasticLoadBalancingV2LoadBalancer.ps1 | 3 ++ ...ew-VSElasticLoadBalancingV2TargetGroup.ps1 | 3 ++ .../New-VSElasticsearchDomain.ps1 | 3 ++ .../New-VSEventSchemasDiscoverer.ps1 | 3 ++ .../New-VSEventSchemasRegistry.ps1 | 3 ++ .../New-VSEventSchemasSchema.ps1 | 3 ++ .../Resource Types/New-VSEventsEventBus.ps1 | 3 ++ .../New-VSEventsEventBusPolicy.ps1 | 3 ++ .../Resource Types/New-VSEventsRule.ps1 | 3 ++ .../New-VSFMSNotificationChannel.ps1 | 3 ++ .../Public/Resource Types/New-VSFMSPolicy.ps1 | 3 ++ .../Resource Types/New-VSFSxFileSystem.ps1 | 3 ++ .../Resource Types/New-VSGameLiftAlias.ps1 | 3 ++ .../Resource Types/New-VSGameLiftBuild.ps1 | 3 ++ .../Resource Types/New-VSGameLiftFleet.ps1 | 3 ++ .../New-VSGameLiftGameSessionQueue.ps1 | 3 ++ ...New-VSGameLiftMatchmakingConfiguration.ps1 | 3 ++ .../New-VSGameLiftMatchmakingRuleSet.ps1 | 3 ++ .../Resource Types/New-VSGameLiftScript.ps1 | 3 ++ .../Resource Types/New-VSGlueClassifier.ps1 | 3 ++ .../Resource Types/New-VSGlueConnection.ps1 | 3 ++ .../Resource Types/New-VSGlueCrawler.ps1 | 3 ++ ...ew-VSGlueDataCatalogEncryptionSettings.ps1 | 3 ++ .../Resource Types/New-VSGlueDatabase.ps1 | 3 ++ .../Resource Types/New-VSGlueDevEndpoint.ps1 | 3 ++ .../Public/Resource Types/New-VSGlueJob.ps1 | 3 ++ .../Resource Types/New-VSGlueMLTransform.ps1 | 3 ++ .../Resource Types/New-VSGluePartition.ps1 | 3 ++ .../New-VSGlueSecurityConfiguration.ps1 | 3 ++ .../Public/Resource Types/New-VSGlueTable.ps1 | 3 ++ .../Resource Types/New-VSGlueTrigger.ps1 | 3 ++ .../Resource Types/New-VSGlueWorkflow.ps1 | 3 ++ .../New-VSGreengrassConnectorDefinition.ps1 | 3 ++ ...VSGreengrassConnectorDefinitionVersion.ps1 | 3 ++ .../New-VSGreengrassCoreDefinition.ps1 | 3 ++ .../New-VSGreengrassCoreDefinitionVersion.ps1 | 3 ++ .../New-VSGreengrassDeviceDefinition.ps1 | 3 ++ ...ew-VSGreengrassDeviceDefinitionVersion.ps1 | 3 ++ .../New-VSGreengrassFunctionDefinition.ps1 | 3 ++ ...-VSGreengrassFunctionDefinitionVersion.ps1 | 3 ++ .../Resource Types/New-VSGreengrassGroup.ps1 | 3 ++ .../New-VSGreengrassGroupVersion.ps1 | 3 ++ .../New-VSGreengrassLoggerDefinition.ps1 | 3 ++ ...ew-VSGreengrassLoggerDefinitionVersion.ps1 | 3 ++ .../New-VSGreengrassResourceDefinition.ps1 | 3 ++ ...-VSGreengrassResourceDefinitionVersion.ps1 | 3 ++ ...New-VSGreengrassSubscriptionDefinition.ps1 | 3 ++ ...reengrassSubscriptionDefinitionVersion.ps1 | 3 ++ .../New-VSGroundStationConfig.ps1 | 3 ++ ...w-VSGroundStationDataflowEndpointGroup.ps1 | 3 ++ .../New-VSGroundStationMissionProfile.ps1 | 3 ++ .../New-VSGuardDutyDetector.ps1 | 3 ++ .../Resource Types/New-VSGuardDutyFilter.ps1 | 3 ++ .../Resource Types/New-VSGuardDutyIPSet.ps1 | 3 ++ .../Resource Types/New-VSGuardDutyMaster.ps1 | 3 ++ .../Resource Types/New-VSGuardDutyMember.ps1 | 3 ++ .../New-VSGuardDutyThreatIntelSet.ps1 | 3 ++ .../Resource Types/New-VSIAMAccessKey.ps1 | 3 ++ .../Public/Resource Types/New-VSIAMGroup.ps1 | 3 ++ .../New-VSIAMInstanceProfile.ps1 | 3 ++ .../Resource Types/New-VSIAMManagedPolicy.ps1 | 3 ++ .../Public/Resource Types/New-VSIAMPolicy.ps1 | 3 ++ .../Public/Resource Types/New-VSIAMRole.ps1 | 3 ++ .../New-VSIAMServiceLinkedRole.ps1 | 3 ++ .../Public/Resource Types/New-VSIAMUser.ps1 | 3 ++ .../New-VSIAMUserToGroupAddition.ps1 | 3 ++ .../New-VSInspectorAssessmentTarget.ps1 | 3 ++ .../New-VSInspectorAssessmentTemplate.ps1 | 3 ++ .../New-VSInspectorResourceGroup.ps1 | 3 ++ .../Resource Types/New-VSIoT1ClickDevice.ps1 | 3 ++ .../New-VSIoT1ClickPlacement.ps1 | 3 ++ .../Resource Types/New-VSIoT1ClickProject.ps1 | 3 ++ .../New-VSIoTAnalyticsChannel.ps1 | 3 ++ .../New-VSIoTAnalyticsDataset.ps1 | 3 ++ .../New-VSIoTAnalyticsDatastore.ps1 | 3 ++ .../New-VSIoTAnalyticsPipeline.ps1 | 3 ++ .../Resource Types/New-VSIoTCertificate.ps1 | 3 ++ .../New-VSIoTEventsDetectorModel.ps1 | 3 ++ .../Resource Types/New-VSIoTEventsInput.ps1 | 3 ++ .../Public/Resource Types/New-VSIoTPolicy.ps1 | 3 ++ .../New-VSIoTPolicyPrincipalAttachment.ps1 | 3 ++ .../Public/Resource Types/New-VSIoTThing.ps1 | 3 ++ .../New-VSIoTThingPrincipalAttachment.ps1 | 3 ++ .../New-VSIoTThingsGraphFlowTemplate.ps1 | 3 ++ .../Resource Types/New-VSIoTTopicRule.ps1 | 3 ++ .../Public/Resource Types/New-VSKMSAlias.ps1 | 3 ++ .../Public/Resource Types/New-VSKMSKey.ps1 | 3 ++ .../New-VSKinesisAnalyticsApplication.ps1 | 3 ++ ...ew-VSKinesisAnalyticsApplicationOutput.ps1 | 3 ++ ...nalyticsApplicationReferenceDataSource.ps1 | 3 ++ .../New-VSKinesisAnalyticsV2Application.ps1 | 3 ++ ...csV2ApplicationCloudWatchLoggingOption.ps1 | 3 ++ ...-VSKinesisAnalyticsV2ApplicationOutput.ps1 | 3 ++ ...lyticsV2ApplicationReferenceDataSource.ps1 | 3 ++ .../New-VSKinesisFirehoseDeliveryStream.ps1 | 3 ++ .../Resource Types/New-VSKinesisStream.ps1 | 3 ++ .../New-VSKinesisStreamConsumer.ps1 | 3 ++ .../New-VSLakeFormationDataLakeSettings.ps1 | 3 ++ .../New-VSLakeFormationPermissions.ps1 | 3 ++ .../New-VSLakeFormationResource.ps1 | 3 ++ .../Resource Types/New-VSLambdaAlias.ps1 | 3 ++ .../New-VSLambdaEventInvokeConfig.ps1 | 3 ++ .../New-VSLambdaEventSourceMapping.ps1 | 3 ++ .../Resource Types/New-VSLambdaFunction.ps1 | 3 ++ .../New-VSLambdaLayerVersion.ps1 | 3 ++ .../New-VSLambdaLayerVersionPermission.ps1 | 3 ++ .../Resource Types/New-VSLambdaPermission.ps1 | 3 ++ .../Resource Types/New-VSLambdaVersion.ps1 | 3 ++ .../Resource Types/New-VSLogsDestination.ps1 | 3 ++ .../Resource Types/New-VSLogsLogGroup.ps1 | 3 ++ .../Resource Types/New-VSLogsLogStream.ps1 | 3 ++ .../Resource Types/New-VSLogsMetricFilter.ps1 | 3 ++ .../New-VSLogsSubscriptionFilter.ps1 | 3 ++ .../Resource Types/New-VSMSKCluster.ps1 | 3 ++ .../New-VSManagedBlockchainMember.ps1 | 3 ++ .../New-VSManagedBlockchainNode.ps1 | 3 ++ .../New-VSMediaConvertJobTemplate.ps1 | 3 ++ .../New-VSMediaConvertPreset.ps1 | 3 ++ .../New-VSMediaConvertQueue.ps1 | 3 ++ .../Resource Types/New-VSMediaLiveChannel.ps1 | 3 ++ .../Resource Types/New-VSMediaLiveInput.ps1 | 3 ++ .../New-VSMediaLiveInputSecurityGroup.ps1 | 3 ++ .../New-VSMediaStoreContainer.ps1 | 3 ++ .../Resource Types/New-VSNeptuneDBCluster.ps1 | 3 ++ .../New-VSNeptuneDBClusterParameterGroup.ps1 | 3 ++ .../New-VSNeptuneDBInstance.ps1 | 3 ++ .../New-VSNeptuneDBParameterGroup.ps1 | 3 ++ .../New-VSNeptuneDBSubnetGroup.ps1 | 3 ++ .../Resource Types/New-VSOpsWorksApp.ps1 | 3 ++ .../Resource Types/New-VSOpsWorksCMServer.ps1 | 3 ++ ...SOpsWorksElasticLoadBalancerAttachment.ps1 | 3 ++ .../Resource Types/New-VSOpsWorksInstance.ps1 | 3 ++ .../Resource Types/New-VSOpsWorksLayer.ps1 | 3 ++ .../Resource Types/New-VSOpsWorksStack.ps1 | 3 ++ .../New-VSOpsWorksUserProfile.ps1 | 3 ++ .../Resource Types/New-VSOpsWorksVolume.ps1 | 3 ++ .../New-VSPinpointADMChannel.ps1 | 3 ++ .../New-VSPinpointAPNSChannel.ps1 | 3 ++ .../New-VSPinpointAPNSSandboxChannel.ps1 | 3 ++ .../New-VSPinpointAPNSVoipChannel.ps1 | 3 ++ .../New-VSPinpointAPNSVoipSandboxChannel.ps1 | 3 ++ .../Resource Types/New-VSPinpointApp.ps1 | 3 ++ .../New-VSPinpointApplicationSettings.ps1 | 3 ++ .../New-VSPinpointBaiduChannel.ps1 | 3 ++ .../Resource Types/New-VSPinpointCampaign.ps1 | 3 ++ .../New-VSPinpointEmailChannel.ps1 | 3 ++ .../New-VSPinpointEmailConfigurationSet.ps1 | 3 ++ ...tEmailConfigurationSetEventDestination.ps1 | 3 ++ .../New-VSPinpointEmailDedicatedIpPool.ps1 | 3 ++ .../New-VSPinpointEmailIdentity.ps1 | 3 ++ .../New-VSPinpointEmailTemplate.ps1 | 3 ++ .../New-VSPinpointEventStream.ps1 | 3 ++ .../New-VSPinpointGCMChannel.ps1 | 3 ++ .../New-VSPinpointPushTemplate.ps1 | 3 ++ .../New-VSPinpointSMSChannel.ps1 | 3 ++ .../Resource Types/New-VSPinpointSegment.ps1 | 3 ++ .../New-VSPinpointSmsTemplate.ps1 | 3 ++ .../New-VSPinpointVoiceChannel.ps1 | 3 ++ .../Resource Types/New-VSQLDBLedger.ps1 | 3 ++ .../Resource Types/New-VSRAMResourceShare.ps1 | 3 ++ .../Resource Types/New-VSRDSDBCluster.ps1 | 3 ++ .../New-VSRDSDBClusterParameterGroup.ps1 | 3 ++ .../Resource Types/New-VSRDSDBInstance.ps1 | 3 ++ .../New-VSRDSDBParameterGroup.ps1 | 3 ++ .../New-VSRDSDBSecurityGroup.ps1 | 3 ++ .../New-VSRDSDBSecurityGroupIngress.ps1 | 3 ++ .../Resource Types/New-VSRDSDBSubnetGroup.ps1 | 3 ++ .../New-VSRDSEventSubscription.ps1 | 3 ++ .../Resource Types/New-VSRDSOptionGroup.ps1 | 3 ++ .../Resource Types/New-VSRedshiftCluster.ps1 | 3 ++ .../New-VSRedshiftClusterParameterGroup.ps1 | 3 ++ .../New-VSRedshiftClusterSecurityGroup.ps1 | 3 ++ ...-VSRedshiftClusterSecurityGroupIngress.ps1 | 3 ++ .../New-VSRedshiftClusterSubnetGroup.ps1 | 3 ++ .../Resource Types/New-VSRoboMakerFleet.ps1 | 3 ++ .../Resource Types/New-VSRoboMakerRobot.ps1 | 3 ++ .../New-VSRoboMakerRobotApplication.ps1 | 3 ++ ...New-VSRoboMakerRobotApplicationVersion.ps1 | 3 ++ .../New-VSRoboMakerSimulationApplication.ps1 | 3 ++ ...SRoboMakerSimulationApplicationVersion.ps1 | 3 ++ .../New-VSRoute53HealthCheck.ps1 | 3 ++ .../New-VSRoute53HostedZone.ps1 | 3 ++ .../Resource Types/New-VSRoute53RecordSet.ps1 | 3 ++ .../New-VSRoute53RecordSetGroup.ps1 | 3 ++ .../New-VSRoute53ResolverResolverEndpoint.ps1 | 3 ++ .../New-VSRoute53ResolverResolverRule.ps1 | 3 ++ ...Route53ResolverResolverRuleAssociation.ps1 | 3 ++ .../Resource Types/New-VSS3AccessPoint.ps1 | 3 ++ .../Public/Resource Types/New-VSS3Bucket.ps1 | 3 ++ .../Resource Types/New-VSS3BucketPolicy.ps1 | 3 ++ .../Public/Resource Types/New-VSSDBDomain.ps1 | 3 ++ .../New-VSSESConfigurationSet.ps1 | 3 ++ ...-VSSESConfigurationSetEventDestination.ps1 | 3 ++ .../Resource Types/New-VSSESReceiptFilter.ps1 | 3 ++ .../Resource Types/New-VSSESReceiptRule.ps1 | 3 ++ .../New-VSSESReceiptRuleSet.ps1 | 3 ++ .../Resource Types/New-VSSESTemplate.ps1 | 3 ++ .../Resource Types/New-VSSNSSubscription.ps1 | 3 ++ .../Public/Resource Types/New-VSSNSTopic.ps1 | 3 ++ .../Resource Types/New-VSSNSTopicPolicy.ps1 | 3 ++ .../Public/Resource Types/New-VSSQSQueue.ps1 | 3 ++ .../Resource Types/New-VSSQSQueuePolicy.ps1 | 3 ++ .../Resource Types/New-VSSSMAssociation.ps1 | 3 ++ .../Resource Types/New-VSSSMDocument.ps1 | 3 ++ .../New-VSSSMMaintenanceWindow.ps1 | 3 ++ .../New-VSSSMMaintenanceWindowTarget.ps1 | 3 ++ .../New-VSSSMMaintenanceWindowTask.ps1 | 3 ++ .../Resource Types/New-VSSSMParameter.ps1 | 3 ++ .../Resource Types/New-VSSSMPatchBaseline.ps1 | 3 ++ .../New-VSSSMResourceDataSync.ps1 | 3 ++ .../New-VSSageMakerCodeRepository.ps1 | 3 ++ .../New-VSSageMakerEndpoint.ps1 | 3 ++ .../New-VSSageMakerEndpointConfig.ps1 | 3 ++ .../Resource Types/New-VSSageMakerModel.ps1 | 3 ++ .../New-VSSageMakerNotebookInstance.ps1 | 3 ++ ...geMakerNotebookInstanceLifecycleConfig.ps1 | 3 ++ .../New-VSSageMakerWorkteam.ps1 | 3 ++ .../New-VSSecretsManagerResourcePolicy.ps1 | 3 ++ .../New-VSSecretsManagerRotationSchedule.ps1 | 3 ++ .../New-VSSecretsManagerSecret.ps1 | 3 ++ ...VSSecretsManagerSecretTargetAttachment.ps1 | 3 ++ .../Resource Types/New-VSSecurityHubHub.ps1 | 3 ++ ...VSServiceCatalogAcceptedPortfolioShare.ps1 | 3 ++ ...-VSServiceCatalogCloudFormationProduct.ps1 | 3 ++ ...atalogCloudFormationProvisionedProduct.ps1 | 3 ++ ...iceCatalogLaunchNotificationConstraint.ps1 | 3 ++ ...w-VSServiceCatalogLaunchRoleConstraint.ps1 | 3 ++ ...ServiceCatalogLaunchTemplateConstraint.ps1 | 3 ++ .../New-VSServiceCatalogPortfolio.ps1 | 3 ++ ...ceCatalogPortfolioPrincipalAssociation.ps1 | 3 ++ ...viceCatalogPortfolioProductAssociation.ps1 | 3 ++ .../New-VSServiceCatalogPortfolioShare.ps1 | 3 ++ ...ServiceCatalogResourceUpdateConstraint.ps1 | 3 ++ ...New-VSServiceCatalogStackSetConstraint.ps1 | 3 ++ .../New-VSServiceCatalogTagOption.ps1 | 3 ++ ...w-VSServiceCatalogTagOptionAssociation.ps1 | 3 ++ .../New-VSServiceDiscoveryHttpNamespace.ps1 | 3 ++ .../New-VSServiceDiscoveryInstance.ps1 | 3 ++ ...-VSServiceDiscoveryPrivateDnsNamespace.ps1 | 3 ++ ...w-VSServiceDiscoveryPublicDnsNamespace.ps1 | 3 ++ .../New-VSServiceDiscoveryService.ps1 | 3 ++ .../New-VSStepFunctionsActivity.ps1 | 3 ++ .../New-VSStepFunctionsStateMachine.ps1 | 3 ++ .../Resource Types/New-VSTransferServer.ps1 | 3 ++ .../Resource Types/New-VSTransferUser.ps1 | 3 ++ .../Resource Types/New-VSWAFByteMatchSet.ps1 | 3 ++ .../Public/Resource Types/New-VSWAFIPSet.ps1 | 3 ++ .../New-VSWAFRegionalByteMatchSet.ps1 | 3 ++ .../New-VSWAFRegionalGeoMatchSet.ps1 | 3 ++ .../Resource Types/New-VSWAFRegionalIPSet.ps1 | 3 ++ .../New-VSWAFRegionalRateBasedRule.ps1 | 3 ++ .../New-VSWAFRegionalRegexPatternSet.ps1 | 3 ++ .../Resource Types/New-VSWAFRegionalRule.ps1 | 3 ++ .../New-VSWAFRegionalSizeConstraintSet.ps1 | 3 ++ .../New-VSWAFRegionalSqlInjectionMatchSet.ps1 | 3 ++ .../New-VSWAFRegionalWebACL.ps1 | 3 ++ .../New-VSWAFRegionalWebACLAssociation.ps1 | 3 ++ .../New-VSWAFRegionalXssMatchSet.ps1 | 3 ++ .../Public/Resource Types/New-VSWAFRule.ps1 | 3 ++ .../New-VSWAFSizeConstraintSet.ps1 | 3 ++ .../New-VSWAFSqlInjectionMatchSet.ps1 | 3 ++ .../Public/Resource Types/New-VSWAFWebACL.ps1 | 3 ++ .../Resource Types/New-VSWAFXssMatchSet.ps1 | 3 ++ .../Resource Types/New-VSWAFv2IPSet.ps1 | 3 ++ .../New-VSWAFv2RegexPatternSet.ps1 | 3 ++ .../Resource Types/New-VSWAFv2RuleGroup.ps1 | 3 ++ .../Resource Types/New-VSWAFv2WebACL.ps1 | 3 ++ .../New-VSWAFv2WebACLAssociation.ps1 | 3 ++ .../New-VSWorkSpacesWorkspace.ps1 | 3 ++ build.ps1 | 2 +- ci/Convert-SpecToFunction.ps1 | 2 +- invoke.build.ps1 | 7 +++++ 513 files changed, 1544 insertions(+), 14 deletions(-) create mode 100644 VaporShell.Core.dll rename Add-FnCidr.ps1 => VaporShell/Public/Intrinsic Functions/Add-FnCidr.ps1 (100%) rename Add-FnTransform.ps1 => VaporShell/Public/Intrinsic Functions/Add-FnTransform.ps1 (100%) diff --git a/VaporShell.Core.dll b/VaporShell.Core.dll new file mode 100644 index 0000000000000000000000000000000000000000..e2a24afd80d555d5cf435dbe16a5cba373bcb621 GIT binary patch literal 11776 zcmeHNeQ;dWbwBU!+qbLL2S}DJfrY)cY$LStB3U+(i7=8affX!USh9>Ax6(>_mKRq0 z#M`$5AvP7`@YSXr(}aGcZR+AM4NYmG^#sb42~DRdX-kH5@<-AE4-C_0m^4E&Wm*Ep z?(dxY-tI~^76YViVw0GpW$Ai({p!M-eqn&6ID3+!^1UZW19>+~|rL>i{n+a^cTqglR=PN`# z53(r#FFk#fNw~H^?>=sf6WzgqSbi-MRe?6tM>MjW_i=cfC|bsk0^ePRCq4UK5BL{0 z0)QvJ`gQ}8D-NrYZqA(qCbo^E!H%}zF1va#T}ju@I1pr8X%RQ;YQtT2^$_hWL#26? zsyK>tS#)8O+6lxmN__ z)tcO-$-vCk743@VU;=EZrBHqaTJ`5bF{|xLQW|Z6msVwBG?cH^%&KTxKSUX;u5cQN zVlH~mI*n+pFl)`WFoh};n|xMBkrl2Dw^fp=Xh8}$57Cp* zgK=xs0!zTZC^R%A%|s*-={gSPs#dj9dXvf_K(RuMH7zi7t^w{o3P;oe1~+qSfIDje zs9fMN5r|w=fTOfZhbb=objJcrGF5|&+YlJAs&$Q8U`FfJxpfe}FF-jSypG_Q@5kD6 zosDXN9Tk^5E7d9;fmmY2D#?+Ur4~3zBva7lOewGvXmh$0*j@`Gw$vc3<&mre!;fS& znuz0Sj6YS3BlBa{+7Ax(Ll2?1+=wo9mfegqFVR6~BB}-XWxbZzNa&a38E8zZM3rz> z3P+lla|ltZ(ZX}zNopIxN^TF5+84BMrqzdadv$x5&LKJA7UIHoRYv*|Ku#Q4%Lo7^ zsuHzbe}+caJrG?Ld;Pn3V9Hq>(+C?)nPO)>Lf%&AQ+Q5=k}y_PMYsPU`lFXx;FVS0 zsTrNhyD;8@0W7Butpe7Hsn&idgC)Arp9v1uWvl=`##amcETFP*I205JSn(cATP?E%vqbc=bg)hHn5NTZ@> zjB0<>0=J!I4q>*S@dNG9c64Kcb_j({9O9>TsL^-m%r6IB*ktDW{luFWR14<-vsf8F zwH0D1i`>|M{``5>0;)(c9TRybs#@TOMX&K%@8#kqVIX=J@#CBGlP}kwZXLt6DnFLU zZqyL)d3|ANLlyE!XNFqfQSvazK+T9)juxH^qNyEVRT2Qr#d_t5EL*;UivC^Dk7V}q zRIguNUZwTRldoj`auw(G%gH9S9Bt%`S>WlFHH-4MWX+5yeYxZ9;gI(XiQpTFCMi0yki=#|$`G zV$QWphS6rC1BuBE2Zbb7fQgV?;0|hm5$8G<$IQo|wO;tXyd>ne&aBiZPp_zv>3t2N zjA>1}W+b44YX<9fALE+A6kRi>U_YxzuuMGG;lb-{nZ2kwW?~L>ZfJY4Wa3NtV39vK@jDXNR~^p86quv@`|PMVg*~pD*QoZiQR`K#(uLI?6;Ux^qVnO z#EVQVh(`;os;tzZ>PV^MIg(Px1YH?0U(%bO1)LVR)Ug;!-BtvNOP!wC`T~on1?eht zfl`N<%d%(UvUqmAjSxe@1yMylNa16(T~BHers)79QB3Kj-CfHk`;M^U!cjEpsZj>Xrm>xxNe-+Q)#5177ak)A}*spO%eVl6~o2!G*86cA& z8PHl{vLVbALp4)sqVCGhFjpd^xu}Ue<7G8b&|*!jkebNdbxq{*RjP@iR%#+2VYw#q zloc4D%?H^6uP3RAuy;vK#QF|uBGyh&6Opz4d64<2i66>&q@j2o!CXl}gPef^tPnZX z5S%wc6hn6j62H>*k7%NB{QwU{mSwS|ky&OQcJfghr;5*mDS23= zJ4s&D?GWQd!MzfF$T%j*o?Ylbi}U?@7Fl4d#e~5HlpS7G+@m3O#twRO?y!)rLXz*# zRSWybEY?ejL`fkVQl_vmP*@-MptoHlYmkE+BUnHme4tZl*A^49OOY9Dby;Qz z3SF#Y7oM?VoON#SG?sEhR7-9k86`J3DDp0W+(01B0=px*fd&oUs%J0@#>%jCY}(*8>HlsNgYxX5#6 zAlg4xx2q0mhmdxdZP=#}A;z8&tP)a;y(d@$trqOl&@zCN-X`>|wWV<1<5V{tWvZ%GgO*k4S1!Z-@8U4ng^{={^Q2;CvrLyhl;E#z{lh#A1{7wkbJ?nh4 z;%sCNnYdkJ#&?k^G3xPoqj;l?(Qco2cX$Dkr+n;{@Xg?TT`(Tq0QR!a~W@_B4o72V}yY*`iM1k;vP(Fvc&mQ~ZMKE{?+)4M3lfo0XS2E~?V z?1e}IyiFRD(W_~*&*RansmteW4u9ULriXouN3VtkUXxryJ5dP?I%QlO)>0J0Y~3A8Y1VbH>$SyYERg}Vm#A>0R$t(-%( zfEKF4`{5W}2Y4lFIm7J&dj$>%yj|cSf%AYX>5l*{dWt+m@>$Yzn@5T~OFuzYKTCPU zrk?&id;|Rr;LWH3EZ+qBChQzcf0T08VSIr6HR~9xWA0-D-=>!h7hI-1N`GwKM~3l! z_&9B)_ly&e|BdKxQ3WU#{Vw``4e-n6(|~_z{RMUVy{4>JsZU1PBP0HtcBvnM%Nn|6 z#H)P8*PB>kPIqPM@W1Dv4}<+(^<2RFxzu?~8!V^liWdeF)e|b&&ZqT?4p_ zS^;kp`Y>P*H00Dc;B#scyT$g z;7bDE5J(}R3+xd%E^txPP3HCp#9oBx__+Pv}ptB-? zj@ksBN9Xs2%cgfeTp-u#Yjz&ohhOHE5tb8>!rmy?}? z)QB?z_7o&ZE1-e?Y<|XeQxh3`yn}{@2kn^&+a1Urb#^(Kj6Lb4oh%rEnCG~__M~$j z9^E@;#>Q?*XH%KXe4ubk(E_y6o;||`pgH2Evbm#vr&!sYXn@!nPrlK$9rMNq2+#L^p+#56j zkMih#N>jUvV%w>E(3#4^6)Kv=Iw99NHkQuL<~>1&=W_@|vJ}u<@>V-*yJ?&wZEtK> z-gWJ)H<-$%rtPVbW3HW=8kmBT3@b@{=~Sjj?46pTtnKBzRCX%mP8H_`@uY#ibZ*wk zacoQW6vJI24dVp>B0Tio)C^?jXKfly%{uPzF*}oiovuy3&1E{1TD=X!I>yFefoIb$ zXJ$5?v0ZTogsEN+?-vt!u=?zY{PZ*%Q=;|ea!9Yt{7Bj>Cl7c?KxEc1>l{o?9!qD- zIu%2U)GetRNx5*~7W{Z<-{ZJnzFMcdNB4auy@pUbI9upnVk3TOp22} zmAO#LoyJdpol{ zX_8Z!jHDGNbjI&nO1nUr&U21qvN!KJI@$qqzkSp%Iy6ukmG(N`aDEmUiWKX=cha8a z$S$c?KoB>ngglAGg@LpRbeHrM*IzQIYe>^>Kjr5aexBW& z%%mUFw2yMB;F^&`N^Kn*^Y9x!XOx$M6@mJ)FpCPkqiA)v+4H$lMg;M=NYCQLz}e(} zJ7;@vc`ofbSx%gbb?_@{dB^25>KEF}?0u=Z{1~mlEV2_HBlZbQ=e7Jl({L&CFQK{I zg>upE9b3l6CiTum1KAu77c}V1*?akK6?$DaHLt4%Tjn;!1@j zi*;=W%a-W+QJnv0$sw0=bc}3#!OGy=wjZq=sCm#Q(N5y@m7-~)gTpirjtANdsDq$p zg~Pawwg+l2`g!O*1CB>&w6dTM(J)T!dFjo(eK@V%i9VB%p~!7$%@b9!JsC*Zav=Mi zpS?VN)!BdPKR(@XUH?=6_1k2|4I>(glMzOvwwBQvZr0(PPRd$Y_e(}yzZu6X1n?%{ zy}+Y!V#W&ern*C6ZZ`q;8ch`uOEsywex)KTb2pS}7&jDDM2seUkc;9O6&>?NT_GG- zMh$D$hyk@0NKt5y7{3ktO-*48x%eov4luYf5($H^6vjy#HG$R{t&bmY zUZP4xy{vHZ+LF@wT#{=i32=SAB7BO*TNRdLKW=W6UHr|u{MtXHGD*4R1d>$2$6NJaTK=J5n;btSJZHBhJK~M`Z4fl%21U0?P%Hvr`i^yt{YH zwj0PF=~F-TM}jvuKR-16r90n!>&>y$)aJvmIJi7+#{+EXGx*CYO&!Alyf2d(#HLC! zxk;SHZ8=$KF22RZDMMf06=`aPOwlrR0fStIh^T&7m2NGC{f9e1H8 zjcShfB!-{L(HV0`!b|1WFCqJpiDd|%N2wqid) z45$ZDGO*L|9y2Rr%)_IU>`$z}wBrqz?RYHj%C56p`UjTxftJG_#dgdVce78TryW(% zDB3*=J-o;2-H`itU{7o>-aJqBkmpG8?&{*nJ7LN4kGDICzpvuGoB#Y!LC+rOm=+D} z*(~-}_Fx(wW4Dz>F(l*d^XVLA9xw2lG2YQH6|d5`I_^Wz=fIY{?CT}#FQtbN3;f=M zQ$l(F_Bo_%y5j`uIv)uVsgdt}=$nBD(x?*B>z{u{&! B=qCUG literal 0 HcmV?d00001 diff --git a/VaporShell.Core/VaporShell.Core.cs b/VaporShell.Core/VaporShell.Core.cs index 1cd96bd78..59d9a15f1 100644 --- a/VaporShell.Core/VaporShell.Core.cs +++ b/VaporShell.Core/VaporShell.Core.cs @@ -80,18 +80,9 @@ private IEnumerable TransformPSObject(PSObject inputData) } } - private object TransformData(object inputData) + private object TransformSingle(object inputData) { - if (inputData is Array) - { - var formatted = new List(); - foreach (object item in inputData as object[]) - { - formatted.Add((this.TransformData(item) as PSObject)); - } - return formatted; - } - else if (inputData is IDictionary) + if (inputData is IDictionary) { return this.TransformHashtable(inputData as IDictionary); } @@ -107,8 +98,22 @@ private object TransformData(object inputData) return this.TransformPSObject(psObject); } } + return null; + } - return inputData; + private IEnumerable TransformData(object inputData) + { + if (inputData is Array) + { + foreach (object item in inputData as Array) + { + yield return this.TransformSingle(item); + } + } + else + { + yield return this.TransformSingle(inputData); + } } public override object Transform(EngineIntrinsics engineIntrinsics, object inputData) diff --git a/Add-FnCidr.ps1 b/VaporShell/Public/Intrinsic Functions/Add-FnCidr.ps1 similarity index 100% rename from Add-FnCidr.ps1 rename to VaporShell/Public/Intrinsic Functions/Add-FnCidr.ps1 diff --git a/Add-FnTransform.ps1 b/VaporShell/Public/Intrinsic Functions/Add-FnTransform.ps1 similarity index 100% rename from Add-FnTransform.ps1 rename to VaporShell/Public/Intrinsic Functions/Add-FnTransform.ps1 diff --git a/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 b/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 index 2dbeb2c75..34736a87a 100644 --- a/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSACMPCACertificate.ps1 @@ -142,6 +142,9 @@ This parameter should not be confused with the SigningAlgorithm parameter used t [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 index ee5915045..cd5025167 100644 --- a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 +++ b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthority.ps1 @@ -148,6 +148,9 @@ This parameter should not be confused with the SigningAlgorithm parameter used t [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 index 3f42d8d4e..94fc52bff 100644 --- a/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSACMPCACertificateAuthorityActivation.ps1 @@ -132,6 +132,9 @@ function New-VSACMPCACertificateAuthorityActivation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 b/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 index 1670d858c..0959cc348 100644 --- a/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAccessAnalyzerAnalyzer.ps1 @@ -127,6 +127,9 @@ function New-VSAccessAnalyzerAnalyzer { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 index b5e48d51e..d6f25dbbb 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQBroker.ps1 @@ -330,6 +330,9 @@ This permission is required to attach the ENI to the broker instance. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 index 4ce0f0deb..441123fe6 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQConfiguration.ps1 @@ -169,6 +169,9 @@ function New-VSAmazonMQConfiguration { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 index 9a3e02a45..b32e1d4d3 100644 --- a/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmazonMQConfigurationAssociation.ps1 @@ -87,6 +87,9 @@ function New-VSAmazonMQConfigurationAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 index daff5d610..0bc681dac 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyApp.ps1 @@ -253,6 +253,9 @@ function New-VSAmplifyApp { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 index dc1c76ec1..6001923fa 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyBranch.ps1 @@ -248,6 +248,9 @@ For more information, see Web Previews: https://docs.aws.amazon.com/amplify/late [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 b/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 index b3e55200d..bbf24775d 100644 --- a/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAmplifyDomain.ps1 @@ -115,6 +115,9 @@ function New-VSAmplifyDomain { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 index bc4c7e5ad..a15b983f6 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayAccount.ps1 @@ -84,6 +84,9 @@ If an API Gateway resource has been created in your AWS account, no dependency i [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 index 1976f8ca6..11287256c 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayApiKey.ps1 @@ -201,6 +201,9 @@ If you specify a name, you cannot perform updates that require replacement of th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 index 0d9864097..c47c0fbcf 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayAuthorizer.ps1 @@ -240,6 +240,9 @@ If you specify REQUEST for the Type property, specify a comma-separated string o [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 index 7ac097f53..bc65b31e9 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayBasePathMapping.ps1 @@ -132,6 +132,9 @@ function New-VSApiGatewayBasePathMapping { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 index 890134b5a..057441e19 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayClientCertificate.ps1 @@ -90,6 +90,9 @@ function New-VSApiGatewayClientCertificate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 index f8ca684b1..a4d5a7edf 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDeployment.ps1 @@ -132,6 +132,9 @@ function New-VSApiGatewayDeployment { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 index 390cdb93b..6f18dbcbe 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationPart.ps1 @@ -105,6 +105,9 @@ function New-VSApiGatewayDocumentationPart { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 index 674222f0c..aed5eaf02 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDocumentationVersion.ps1 @@ -114,6 +114,9 @@ function New-VSApiGatewayDocumentationVersion { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 index 591ad0f0f..c2e10c9f7 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayDomainName.ps1 @@ -156,6 +156,9 @@ Valid values include TLS_1_0 and TLS_1_2. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 index 73bfe5fd1..8dc8b12ce 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayGatewayResponse.ps1 @@ -138,6 +138,9 @@ function New-VSApiGatewayGatewayResponse { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 index d1de0a537..4ae115784 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayMethod.ps1 @@ -269,6 +269,9 @@ If you specify the AuthorizerId property, specify CUSTOM for this property. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 index 6801cb27a..9801c9263 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayModel.ps1 @@ -151,6 +151,9 @@ If you specify a name, you cannot perform updates that require replacement of th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 index 4ec8e1333..9213122eb 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayRequestValidator.ps1 @@ -132,6 +132,9 @@ function New-VSApiGatewayRequestValidator { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 index 78354b8bc..1eea22be5 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayResource.ps1 @@ -114,6 +114,9 @@ function New-VSApiGatewayResource { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 index 539958fee..5720e720b 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayRestApi.ps1 @@ -263,6 +263,9 @@ On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 index cade16654..a590dfde3 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayStage.ps1 @@ -285,6 +285,9 @@ For more information, see Trace API Gateway API Execution with AWS X-Ray: https: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 index 0b7c0ac6e..45fc0dd4d 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlan.ps1 @@ -146,6 +146,9 @@ function New-VSApiGatewayUsagePlan { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 index 6a2386468..c4c895cd1 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayUsagePlanKey.ps1 @@ -114,6 +114,9 @@ function New-VSApiGatewayUsagePlanKey { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 index ef5bd3845..51bd640b9 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Api.ps1 @@ -332,6 +332,9 @@ function New-VSApiGatewayV2Api { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 index 8de01efca..70e3ff6a8 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2ApiMapping.ps1 @@ -132,6 +132,9 @@ function New-VSApiGatewayV2ApiMapping { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 index bafd06942..a31067525 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Authorizer.ps1 @@ -209,6 +209,9 @@ For JWT, a single entry that specifies where to extract the JSON Web Token JWT f [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 index c0598fce5..62e02c84b 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Deployment.ps1 @@ -114,6 +114,9 @@ function New-VSApiGatewayV2Deployment { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 index 1ab4ee6aa..d6127eaf3 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2DomainName.ps1 @@ -117,6 +117,9 @@ You can use a custom domain name to provide a URL that's more intuitive and easi [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 index d39c3feb1..b9d2edc50 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Integration.ps1 @@ -325,6 +325,9 @@ MOCK: for integrating the route or method request with API Gateway as a "loopbac [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 index 479ef6a8c..d26ccbeba 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2IntegrationResponse.ps1 @@ -189,6 +189,9 @@ If this property is not defined, the response payload will be passed through fro [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 index f00430f35..7678b1a7d 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Model.ps1 @@ -150,6 +150,9 @@ function New-VSApiGatewayV2Model { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 index 320ad5982..934fb47ac 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Route.ps1 @@ -268,6 +268,9 @@ function New-VSApiGatewayV2Route { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 index 615c95211..76df7b7d9 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2RouteResponse.ps1 @@ -168,6 +168,9 @@ function New-VSApiGatewayV2RouteResponse { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 index 9e35f9d73..55e264fcb 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayV2Stage.ps1 @@ -240,6 +240,9 @@ function New-VSApiGatewayV2Stage { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 b/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 index bb00ebaf2..ce308b5f5 100644 --- a/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApiGatewayVpcLink.ps1 @@ -106,6 +106,9 @@ function New-VSApiGatewayVpcLink { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 index 74c960ad7..7bc04de1b 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigApplication.ps1 @@ -129,6 +129,9 @@ For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-man [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 index 26c64ec20..cff884bd4 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigConfigurationProfile.ps1 @@ -208,6 +208,9 @@ For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-man [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 index 54ffbbbb4..a1f7364d4 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigDeployment.ps1 @@ -203,6 +203,9 @@ For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-man [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 index 934c22ea1..fbcdc2e5a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigDeploymentStrategy.ps1 @@ -225,6 +225,9 @@ Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4 [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 index a44d8a44a..169cc93f3 100644 --- a/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppConfigEnvironment.ps1 @@ -166,6 +166,9 @@ For more information, see AWS AppConfig: https://docs.aws.amazon.com/systems-man [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 index a818173d6..be8c5624a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshMesh.ps1 @@ -100,6 +100,9 @@ After you create your service mesh, you can create virtual services, virtual nod [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 index 720cb9a25..b4bf24426 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshRoute.ps1 @@ -138,6 +138,9 @@ If your route matches a request, you can distribute traffic to one or more targe [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 index cc5ec2dea..2d4446e60 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualNode.ps1 @@ -126,6 +126,9 @@ If you require your Envoy stats or tracing to use a different name, you can over [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 index fd1993b6a..f56a61542 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualRouter.ps1 @@ -120,6 +120,9 @@ Virtual routers handle traffic for one or more virtual services within your mesh [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 index 86bf65f90..561263119 100644 --- a/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppMeshVirtualService.ps1 @@ -118,6 +118,9 @@ A virtual service is an abstraction of a real service that is provided by a virt [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 index 2d499a4c4..b37d05a0b 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamDirectoryConfig.ps1 @@ -99,6 +99,9 @@ function New-VSAppStreamDirectoryConfig { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 index 147e64aeb..a94d82da0 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamFleet.ps1 @@ -330,6 +330,9 @@ Specify a value between 60 and 360000. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 index 92d95704b..b17794b68 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamImageBuilder.ps1 @@ -280,6 +280,9 @@ The initial state of the image builder is PENDING. When it is ready, the state i [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 index 7089bd696..9ad1ce0d6 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStack.ps1 @@ -266,6 +266,9 @@ Deletes the storage connectors currently enabled for the stack. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 index d6fd9f9d5..23fe073a3 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStackFleetAssociation.ps1 @@ -98,6 +98,9 @@ To associate a fleet with a stack, you must specify a dependency on the stack re [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 index da770faa9..9af6be0d6 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamStackUserAssociation.ps1 @@ -133,6 +133,9 @@ Users' email addresses are case-sensitive. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 b/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 index da24f8088..92f0e0fb1 100644 --- a/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppStreamUser.ps1 @@ -152,6 +152,9 @@ The temporary password in the welcome email is valid for only 7 days. If users d [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 index e56935a48..1d6d80429 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncApiCache.ps1 @@ -178,6 +178,9 @@ Valid values are between 1 and 3600 seconds. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 index 1fee6196a..e0ae22a6c 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncApiKey.ps1 @@ -114,6 +114,9 @@ function New-VSAppSyncApiKey { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 index c2d0f16a9..fd190e795 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncDataSource.ps1 @@ -202,6 +202,9 @@ Required if Type is specified as AWS_LAMBDA, AMAZON_DYNAMODB, or AMAZON_ELASTICS [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 index 3482bc6df..bef343a67 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncFunctionConfiguration.ps1 @@ -222,6 +222,9 @@ function New-VSAppSyncFunctionConfiguration { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 index 734f473c5..6807b4bfa 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLApi.ps1 @@ -159,6 +159,9 @@ function New-VSAppSyncGraphQLApi { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 index ef35c2c48..9cee0b2ae 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncGraphQLSchema.ps1 @@ -115,6 +115,9 @@ For more information about using the Ref function, see Ref: https://docs.aws.ama [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 b/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 index 77eacffd8..19980e06a 100644 --- a/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAppSyncResolver.ps1 @@ -251,6 +251,9 @@ function New-VSAppSyncResolver { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 index 5fe6146ae..fbc49c9c1 100644 --- a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalableTarget.ps1 @@ -206,6 +206,9 @@ For more information, see Suspending and Resuming Scaling: https://docs.aws.amaz [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 index 59762d295..188fb2dde 100644 --- a/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSApplicationAutoScalingScalingPolicy.ps1 @@ -195,6 +195,9 @@ You must specify either the ResourceId, ScalableDimension, and ServiceNamespace [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 b/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 index 74c5efe85..133d6c14d 100644 --- a/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAthenaNamedQuery.ps1 @@ -132,6 +132,9 @@ function New-VSAthenaNamedQuery { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 index f81611fb4..7c7292145 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingAutoScalingGroup.ps1 @@ -457,6 +457,9 @@ When you update VPCZoneIdentifier, this retains the same Auto Scaling group and [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 index d380e6348..7f24018b4 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingLaunchConfiguration.ps1 @@ -397,6 +397,9 @@ For more information, see Instance Metadata and User Data: https://docs.aws.amaz [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 index e0ab7f78f..399ab5318 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingLifecycleHook.ps1 @@ -208,6 +208,9 @@ For more information, see PutLifecycleHook: https://docs.aws.amazon.com/autoscal [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 index 9effec108..176b26acd 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingPlansScalingPlan.ps1 @@ -100,6 +100,9 @@ For more information, see the AWS Auto Scaling User Guide: https://docs.aws.amaz [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 index d1376a1e0..26169d85b 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingScalingPolicy.ps1 @@ -249,6 +249,9 @@ If you specify TargetTrackingScaling for the policy type, you must specify this [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 b/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 index a88ba961f..b2641ca74 100644 --- a/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 +++ b/VaporShell/Public/Resource Types/New-VSAutoScalingScheduledAction.ps1 @@ -198,6 +198,9 @@ Specifying the StartTime and EndTime properties with Recurrence property forms t [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 b/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 index cf8416482..69544aac9 100644 --- a/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBackupBackupPlan.ps1 @@ -87,6 +87,9 @@ function New-VSBackupBackupPlan { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 b/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 index 7f1b9430c..a8c9ac01b 100644 --- a/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBackupBackupSelection.ps1 @@ -88,6 +88,9 @@ It includes an array of resources, an optional array of patterns to exclude reso [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 b/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 index 217c1de34..a5935fe21 100644 --- a/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBackupBackupVault.ps1 @@ -145,6 +145,9 @@ Sensitive data, such as passport numbers, should not be included the name of a b [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 index e79b5effd..5be227a9b 100644 --- a/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBatchComputeEnvironment.ps1 @@ -143,6 +143,9 @@ Depending on how you created your AWS Batch service role, its ARN may contain th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 index 128e7a21b..3b7f62d95 100644 --- a/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBatchJobDefinition.ps1 @@ -150,6 +150,9 @@ function New-VSBatchJobDefinition { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 b/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 index 0bff5262b..4ea9bd12d 100644 --- a/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBatchJobQueue.ps1 @@ -133,6 +133,9 @@ function New-VSBatchJobQueue { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 b/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 index 9a12d2275..516f7765d 100644 --- a/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSBudgetsBudget.ps1 @@ -88,6 +88,9 @@ function New-VSBudgetsBudget { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 index 81ba061e1..4ca1e5aa2 100644 --- a/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCertificateManagerCertificate.ps1 @@ -143,6 +143,9 @@ When you use the AWS::CertificateManager::Certificate resource in an AWS CloudFo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 b/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 index 325302b0c..63e678cc3 100644 --- a/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloud9EnvironmentEC2.ps1 @@ -198,6 +198,9 @@ function New-VSCloud9EnvironmentEC2 { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 index 6f504fd8c..61da02a67 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationCustomResource.ps1 @@ -86,6 +86,9 @@ Updates are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 index f9a0fc511..a8192b6bf 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationMacro.ps1 @@ -150,6 +150,9 @@ function New-VSCloudFormationMacro { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 index 295d07a69..a1a171d0f 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationStack.ps1 @@ -148,6 +148,9 @@ Updates are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 index c08710e86..2b0950648 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitCondition.ps1 @@ -148,6 +148,9 @@ Updates are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 index ca716b7a6..89d12bfbc 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFormationWaitConditionHandle.ps1 @@ -74,6 +74,9 @@ Updates are not supported for this resource. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 index 0dd380af1..59e879701 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontCloudFrontOriginAccessIdentity.ps1 @@ -69,6 +69,9 @@ function New-VSCloudFrontCloudFrontOriginAccessIdentity { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 index f12ae65f0..53e3fcaa5 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontDistribution.ps1 @@ -80,6 +80,9 @@ function New-VSCloudFrontDistribution { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 b/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 index 3f4445944..ab505b814 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudFrontStreamingDistribution.ps1 @@ -80,6 +80,9 @@ function New-VSCloudFrontStreamingDistribution { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 b/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 index c0ac6365a..b65bcf519 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudTrailTrail.ps1 @@ -304,6 +304,9 @@ arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 index d3f6598b4..45fc57e8c 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchAlarm.ps1 @@ -432,6 +432,9 @@ If you omit this parameter, the default behavior of missing is used. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 index fc3f55711..8248ba7b5 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchAnomalyDetector.ps1 @@ -142,6 +142,9 @@ function New-VSCloudWatchAnomalyDetector { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 index a70058257..891c6c021 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchCompositeAlarm.ps1 @@ -148,6 +148,9 @@ function New-VSCloudWatchCompositeAlarm { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 index 60304ab6e..ac626bd80 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchDashboard.ps1 @@ -99,6 +99,9 @@ For more information about the syntax, see Dashboard Body Structure and Syntax: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 b/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 index b49308d4f..f38926877 100644 --- a/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCloudWatchInsightRule.ps1 @@ -114,6 +114,9 @@ function New-VSCloudWatchInsightRule { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 index 390637c68..b6c78795c 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildProject.ps1 @@ -364,6 +364,9 @@ These tags are available for use by AWS services that support AWS CodeBuild buil [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 index a6d516386..2270a1cba 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildReportGroup.ps1 @@ -105,6 +105,9 @@ function New-VSCodeBuildReportGroup { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 b/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 index 3340ef2d6..c3155887c 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeBuildSourceCredential.ps1 @@ -136,6 +136,9 @@ For security purposes, do not use plain text in your CloudFormation template to [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 b/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 index d2063fae6..d129bedcc 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeCommitRepository.ps1 @@ -137,6 +137,9 @@ The description field for a repository accepts all HTML characters and all valid [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 index f911662d1..ee8763aed 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployApplication.ps1 @@ -97,6 +97,9 @@ Updates to ApplicationName are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 index 6e5abd3d2..50af5a232 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentConfig.ps1 @@ -94,6 +94,9 @@ For more information about instance health, see CodeDeploy Instance Health: http [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 index 5f28d02aa..ac03faf6a 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeDeployDeploymentGroup.ps1 @@ -273,6 +273,9 @@ In some cases, you might need to add a dependency on the service role's policy. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 index 7c64cb19c..790a9fd97 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelineCustomActionType.ps1 @@ -174,6 +174,9 @@ You can refer to a name in the configuration properties of the custom action wit [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 index b6b0788b5..39347d448 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelinePipeline.ps1 @@ -197,6 +197,9 @@ You must include either artifactStore or artifactStores in your pipeline, but yo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 b/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 index ed72a2151..1204e5464 100644 --- a/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodePipelineWebhook.ps1 @@ -205,6 +205,9 @@ When passing secret parameters, do not enter the value directly into the templat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 b/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 index 0bee02c5c..990a68249 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeStarGitHubRepository.ps1 @@ -177,6 +177,9 @@ function New-VSCodeStarGitHubRepository { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 b/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 index da6324282..523d39dfb 100644 --- a/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCodeStarNotificationsNotificationRule.ps1 @@ -179,6 +179,9 @@ function New-VSCodeStarNotificationsNotificationRule { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 index fbf3d161d..19137f516 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPool.ps1 @@ -232,6 +232,9 @@ To avoid deleting the resource accidentally from AWS CloudFormation, use Deletio [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 index d9babe480..d4483e98c 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoIdentityPoolRoleAttachment.ps1 @@ -115,6 +115,9 @@ If the IdentityProvider field isn't provided in this object, the string is used [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 index 0b6965a74..efbc2dc2a 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPool.ps1 @@ -347,6 +347,9 @@ This user pool property cannot be updated. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 index 3c0e37d41..2533c95f4 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolClient.ps1 @@ -300,6 +300,9 @@ If your app client allows users to sign in through an identity provider, this ar [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 index bb8a731bd..cc7058d79 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolDomain.ps1 @@ -106,6 +106,9 @@ This string can include only lowercase letters, numbers, and hyphens. Don't use [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 index ebe62c572..bfd1c9fba 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolGroup.ps1 @@ -154,6 +154,9 @@ The default Precedence value is null. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 index 55cd2d40d..9f367e182 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolIdentityProvider.ps1 @@ -183,6 +183,9 @@ function New-VSCognitoUserPoolIdentityProvider { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 index 2d00fa24a..34f86e8a8 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolResourceServer.ps1 @@ -133,6 +133,9 @@ function New-VSCognitoUserPoolResourceServer { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 index 1a1722dc6..def5fcbf8 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolRiskConfigurationAttachment.ps1 @@ -127,6 +127,9 @@ You can specify risk configuration for a single client (with a specific clientId [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 index 0e6ed4d37..130625e87 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUICustomizationAttachment.ps1 @@ -122,6 +122,9 @@ Setting a logo image isn't supported from AWS CloudFormation. Use the Amazon Cog [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 index 7b23cb34e..b3574945f 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUser.ps1 @@ -213,6 +213,9 @@ In your call to AdminCreateUser, you can set the email_verified attribute to Tru [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 index c6912ba6b..cf51d11f4 100644 --- a/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSCognitoUserPoolUserToGroupAttachment.ps1 @@ -116,6 +116,9 @@ Calling this action requires developer credentials. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 b/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 index e660b3d75..6d79b6305 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigAggregationAuthorization.ps1 @@ -105,6 +105,9 @@ function New-VSConfigAggregationAuthorization { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 index dbda7615f..d6db0bd75 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigRule.ps1 @@ -169,6 +169,9 @@ By default, rules with a periodic trigger are evaluated every 24 hours. To chang [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 index 88070f9dd..0f1574048 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigurationAggregator.ps1 @@ -115,6 +115,9 @@ function New-VSConfigConfigurationAggregator { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 index 54152a0ae..a9f239d71 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConfigurationRecorder.ps1 @@ -113,6 +113,9 @@ Updates are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 b/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 index 5103d782b..d24a618d5 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigConformancePack.ps1 @@ -171,6 +171,9 @@ You must have access to read Amazon S3 bucket. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 b/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 index 81082de25..05e047a4b 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigDeliveryChannel.ps1 @@ -160,6 +160,9 @@ If you choose a topic from another account, the topic must have policies that gr [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 index 4f55d3403..5df4520c0 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConfigRule.ps1 @@ -108,6 +108,9 @@ OrganizationConfigRule resource enables organization service access through Enab [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 index 2b8f514ff..7f58c6560 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigOrganizationConformancePack.ps1 @@ -179,6 +179,9 @@ function New-VSConfigOrganizationConformancePack { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 index 60924eabd..a66f96d3c 100644 --- a/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSConfigRemediationConfiguration.ps1 @@ -234,6 +234,9 @@ For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeco [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 b/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 index 0c9ce09c6..340c75107 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXCluster.ps1 @@ -273,6 +273,9 @@ If this parameter is not specified, DAX assigns the default VPC security group t [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 index 497853a02..f0e385183 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXParameterGroup.ps1 @@ -114,6 +114,9 @@ function New-VSDAXParameterGroup { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 index 034cd1673..26870c8be 100644 --- a/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDAXSubnetGroup.ps1 @@ -106,6 +106,9 @@ function New-VSDAXSubnetGroup { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 index 50752fff0..4f887365d 100644 --- a/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDLMLifecyclePolicy.ps1 @@ -125,6 +125,9 @@ The properties are required when you add a lifecycle policy and optional when yo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 index 3a2e98c5b..40df9677c 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSCertificate.ps1 @@ -114,6 +114,9 @@ function New-VSDMSCertificate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 index 1bfc442de..f97d9d673 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSEndpoint.ps1 @@ -336,6 +336,9 @@ AWS KMS creates the default encryption key for your AWS account. Your AWS accoun [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 index 95776a2d1..2989b575d 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSEventSubscription.ps1 @@ -166,6 +166,9 @@ If you specify multiple values, they must be of the same type. For example, if y [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 index 3726d3c6d..b91a16e75 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationInstance.ps1 @@ -312,6 +312,9 @@ Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 index 6275a9785..ae86da00d 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationSubnetGroup.ps1 @@ -121,6 +121,9 @@ Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 b/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 index b9ff5e48d..80999d9c4 100644 --- a/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDMSReplicationTask.ps1 @@ -262,6 +262,9 @@ Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 b/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 index 3f01f346b..4d318319f 100644 --- a/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDataPipelinePipeline.ps1 @@ -208,6 +208,9 @@ Pipeline object definitions are passed to the PutPipelineDefinition: https://doc [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 b/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 index fff47fb64..250ebce4c 100644 --- a/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDirectoryServiceMicrosoftAD.ps1 @@ -181,6 +181,9 @@ If you need to change the password for the administrator account, see the ResetU [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 b/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 index ff995f735..baa520a50 100644 --- a/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDirectoryServiceSimpleAD.ps1 @@ -199,6 +199,9 @@ If you need to change the password for the administrator account, see the ResetU [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 index 1c201f821..e17bd25d5 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBCluster.ps1 @@ -371,6 +371,9 @@ Constraints: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 index 4a66b85ce..8f83a5d4e 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBClusterParameterGroup.ps1 @@ -154,6 +154,9 @@ This value is stored as a lowercase string. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 index a7b59662c..75f06e5a7 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBInstance.ps1 @@ -192,6 +192,9 @@ Example: mydbinstance [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 index 660fb0a09..a401780c2 100644 --- a/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDocDBDBSubnetGroup.ps1 @@ -119,6 +119,9 @@ Example: mySubnetgroup [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 b/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 index c41a9b0cc..381e9540d 100644 --- a/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSDynamoDBTable.ps1 @@ -253,6 +253,9 @@ For detailed information about the limits in DynamoDB, see Limits in Amazon Dyna [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 index bfe75d5dd..f545a299e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2CapacityReservation.ps1 @@ -268,6 +268,9 @@ If the EndDateType is limited, the Capacity Reservation is cancelled within an h [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 index 311a68e9e..4e4b6f61e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnAuthorizationRule.ps1 @@ -150,6 +150,9 @@ function New-VSEC2ClientVpnAuthorizationRule { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 index 1de90766e..941c3a23b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnEndpoint.ps1 @@ -235,6 +235,9 @@ Default Value: 443 [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 index 0dc4bfe8b..52ed411a6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnRoute.ps1 @@ -138,6 +138,9 @@ Route address ranges cannot overlap with the CIDR range specified for client all [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 index a55572208..e27b7c49d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2ClientVpnTargetNetworkAssociation.ps1 @@ -96,6 +96,9 @@ function New-VSEC2ClientVpnTargetNetworkAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 index 6feaeb831..6c517afa9 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2CustomerGateway.ps1 @@ -127,6 +127,9 @@ Default: 65000 [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 b/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 index 087052849..d7d7a2134 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2DHCPOptions.ps1 @@ -143,6 +143,9 @@ You must specify at least one of the following properties: DomainNameServers, Ne [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 index 2e611aecf..06dec2926 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EC2Fleet.ps1 @@ -233,6 +233,9 @@ function New-VSEC2EC2Fleet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 index 3705a4571..3baadb32b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EIP.ps1 @@ -140,6 +140,9 @@ Updates to the Tags property may require *some interruptions*. Updates on an EIP [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 index d65682723..89220f5e6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EIPAssociation.ps1 @@ -157,6 +157,9 @@ For EC2-VPC, you can specify either the instance ID or the network interface ID, [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 index ca7309312..f7ba47eea 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2EgressOnlyInternetGateway.ps1 @@ -78,6 +78,9 @@ function New-VSEC2EgressOnlyInternetGateway { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 b/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 index f30e65e80..f5b3d19b4 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2FlowLog.ps1 @@ -193,6 +193,9 @@ Constraints: Maximum of 1000 resources [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 index 583443e7a..988f19a4b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2GatewayRouteTableAssociation.ps1 @@ -96,6 +96,9 @@ function New-VSEC2GatewayRouteTableAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 index 9baca4869..6036c7f90 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Host.ps1 @@ -135,6 +135,9 @@ If you want the Dedicated Hosts to support multiple instance types in a specific [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 index 202a35442..d74cb1e68 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Instance.ps1 @@ -728,6 +728,9 @@ If you specify a network interface, you must specify any subnets as part of the [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 index 679f711a5..9158ededc 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2InternetGateway.ps1 @@ -72,6 +72,9 @@ function New-VSEC2InternetGateway { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 index 1289c7e75..cc8251150 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2LaunchTemplate.ps1 @@ -87,6 +87,9 @@ function New-VSEC2LaunchTemplate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 index dfd6bf1ca..c38052582 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRoute.ps1 @@ -114,6 +114,9 @@ function New-VSEC2LocalGatewayRoute { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 index e689ad0a8..a34bcd8ab 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2LocalGatewayRouteTableVPCAssociation.ps1 @@ -105,6 +105,9 @@ function New-VSEC2LocalGatewayRouteTableVPCAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 index af489c422..3b8b14030 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NatGateway.ps1 @@ -110,6 +110,9 @@ If you add a default route (AWS::EC2::Route resource that points to a NAT gatewa [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 index 65236721b..983664d3e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkAcl.ps1 @@ -90,6 +90,9 @@ function New-VSEC2NetworkAcl { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 index da298851a..03d00bbaa 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkAclEntry.ps1 @@ -207,6 +207,9 @@ If you specify -1, all ports are opened and the PortRange property is ignored. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 index 87a8cb3d0..4700615f7 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterface.ps1 @@ -239,6 +239,9 @@ The number of IP addresses you can assign to a network interface varies by insta [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 index 54b46098d..147692484 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfaceAttachment.ps1 @@ -132,6 +132,9 @@ function New-VSEC2NetworkInterfaceAttachment { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 index ee7694c55..33c531b5b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2NetworkInterfacePermission.ps1 @@ -114,6 +114,9 @@ function New-VSEC2NetworkInterfacePermission { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 b/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 index 4feabad19..59e0cc993 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2PlacementGroup.ps1 @@ -82,6 +82,9 @@ For more information, see Placement Groups: https://docs.aws.amazon.com/AWSEC2/l [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 index 3f6762eeb..33c29b662 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Route.ps1 @@ -244,6 +244,9 @@ You must specify the DestinationCidrBlock or DestinationIpv6CidrBlock property. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 b/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 index ebf6e7159..a8bbffd36 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2RouteTable.ps1 @@ -92,6 +92,9 @@ For more information, see Route Tables: https://docs.aws.amazon.com/AmazonVPC/la [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 index bc2c19b63..1ba2112d1 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroup.ps1 @@ -178,6 +178,9 @@ Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/#,@]+=&;{}!$* [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 index f1bafee4a..dac2cc093 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupEgress.ps1 @@ -237,6 +237,9 @@ VPC only] Use -1 to specify all protocols. When authorizing security group rules [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 index 67e2f53ef..bfc2e42b2 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SecurityGroupIngress.ps1 @@ -293,6 +293,9 @@ Use this for ICMP and any protocol that uses ports. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 index cb026961d..156f38c98 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SpotFleet.ps1 @@ -81,6 +81,9 @@ For more information, see Spot Fleet Requests: https://docs.aws.amazon.com/AWSEC [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 index 30a373f40..c58c7be76 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Subnet.ps1 @@ -191,6 +191,9 @@ If you update this property, you must also update the CidrBlock property. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 index d5a95bf8a..528599c2e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetCidrBlock.ps1 @@ -96,6 +96,9 @@ function New-VSEC2SubnetCidrBlock { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 index bc04718e2..69cd38341 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetNetworkAclAssociation.ps1 @@ -98,6 +98,9 @@ When AWS::EC2::SubnetNetworkAclAssociation resources are created during create o [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 index 5791ec93d..8f2c8c06f 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2SubnetRouteTableAssociation.ps1 @@ -97,6 +97,9 @@ The physical ID changes when the route table ID is changed. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 index 7f28da003..99e96431e 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilter.ps1 @@ -104,6 +104,9 @@ Valid values are amazon-dns. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 index 7dc3aa3dc..bc285c324 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorFilterRule.ps1 @@ -227,6 +227,9 @@ For information about the protocol value, see Protocol Numbers: https://www.iana [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 index 0a5e5aa9d..1441b869c 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorSession.ps1 @@ -205,6 +205,9 @@ If you do not want to mirror the entire packet, use the PacketLength parameter t [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 index 3132c6192..d8e2ca47a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TrafficMirrorTarget.ps1 @@ -131,6 +131,9 @@ To use the target in a Traffic Mirror session, use AWS::EC2::TrafficMirrorSessio [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 index adc64dcf6..f65814125 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGateway.ps1 @@ -205,6 +205,9 @@ When you create a transit gateway, we create a default transit gateway route tab [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 index f3178dfe8..4d09aa499 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayAttachment.ps1 @@ -121,6 +121,9 @@ To send VPC traffic to an attached transit gateway, add a route to the VPC route [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 index e5bc4c51b..a6c095672 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRoute.ps1 @@ -132,6 +132,9 @@ function New-VSEC2TransitGatewayRoute { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 index 8e1264f91..42b984bf6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTable.ps1 @@ -89,6 +89,9 @@ function New-VSEC2TransitGatewayRouteTable { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 index 019f99f97..c0453cb7d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTableAssociation.ps1 @@ -100,6 +100,9 @@ The TransitGatewayRouteTableId value changes when you use AWS::EC2::TransitGatew [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 index b50c9300e..7a091369d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2TransitGatewayRouteTablePropagation.ps1 @@ -98,6 +98,9 @@ For more information about enabling transit gateway route propagation, see Enabl [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 index 847d07b12..b36b6e4b6 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPC.ps1 @@ -148,6 +148,9 @@ Updating InstanceTenancy requires no replacement only if you are updating its va [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 index 5af444b5e..99126ea8c 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCCidrBlock.ps1 @@ -116,6 +116,9 @@ For more information about associating CIDR blocks with your VPC and applicable [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 index cc169b202..b5cf4c6f5 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCDHCPOptionsAssociation.ps1 @@ -98,6 +98,9 @@ After you associate the options with the VPC, any existing instances and all new [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 index 7e014ca48..70478db17 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpoint.ps1 @@ -193,6 +193,9 @@ This field is required when the endpoint is an interface. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 index 3e3e8570a..1d398866d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointConnectionNotification.ps1 @@ -126,6 +126,9 @@ You can create a connection notification for interface endpoints only. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 index 28bbb8b0a..c8a27d51d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointService.ps1 @@ -90,6 +90,9 @@ To create an endpoint service configuration, you must first create a Network Loa [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 index 8b742390c..bb03f841b 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCEndpointServicePermissions.ps1 @@ -90,6 +90,9 @@ If you grant permissions to all principals, the service is public. Any users who [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 index 7a94470e3..c24613533 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCGatewayAttachment.ps1 @@ -116,6 +116,9 @@ You must specify either InternetGatewayId or VpnGatewayId, but not both. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 index 0391d4a9e..342134a6d 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPCPeeringConnection.ps1 @@ -173,6 +173,9 @@ This is required when you are peering a VPC in a different AWS account. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 index dac47e54b..5cec60a4a 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNConnection.ps1 @@ -191,6 +191,9 @@ You must specify either TransitGatewayId or VpnGatewayId, but not both. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 index 39155d485..9d2626a58 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNConnectionRoute.ps1 @@ -98,6 +98,9 @@ For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/ [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 index 0e14ea361..225652307 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNGateway.ps1 @@ -101,6 +101,9 @@ For more information, see AWS Site-to-Site VPN: https://docs.aws.amazon.com/vpn/ [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 index 3f7fb1a6c..d70328ac0 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VPNGatewayRoutePropagation.ps1 @@ -91,6 +91,9 @@ If you reference a VPN gateway that is in the same template as your VPN gateway [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 b/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 index ccef192c6..18bbdcdb9 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2Volume.ps1 @@ -247,6 +247,9 @@ Default: gp2 [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 index ba3bbe7eb..06d7a93bf 100644 --- a/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEC2VolumeAttachment.ps1 @@ -120,6 +120,9 @@ If the root volume is detached from an instance with an AWS Marketplace product [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 b/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 index 95978a5c0..8a3ed5244 100644 --- a/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECRRepository.ps1 @@ -118,6 +118,9 @@ If you specify a name, you cannot perform updates that require replacement of th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 b/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 index 298112482..ca6374146 100644 --- a/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSCluster.ps1 @@ -118,6 +118,9 @@ The following basic restrictions apply to tags: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 b/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 index 03c2bf218..6e5f17029 100644 --- a/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSPrimaryTaskSet.ps1 @@ -114,6 +114,9 @@ function New-VSECSPrimaryTaskSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSECSService.ps1 b/VaporShell/Public/Resource Types/New-VSECSService.ps1 index dae2b857a..0c99f5b52 100644 --- a/VaporShell/Public/Resource Types/New-VSECSService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSService.ps1 @@ -396,6 +396,9 @@ A task definition must be specified if the service is using the ECS deployment c [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 index 42f0b9742..33b61b0d1 100644 --- a/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSTaskDefinition.ps1 @@ -342,6 +342,9 @@ For more information about volume definition parameters and defaults, see Amazon [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 b/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 index 2a5baf4f1..822b3e2ea 100644 --- a/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSECSTaskSet.ps1 @@ -225,6 +225,9 @@ If a launchType is specified, the capacityProviderStrategy parameter must be omi [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 b/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 index 126751b37..cf3d08a7b 100644 --- a/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEFSFileSystem.ps1 @@ -188,6 +188,9 @@ function New-VSEFSFileSystem { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 b/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 index 2f128e311..45be7dcaf 100644 --- a/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEFSMountTarget.ps1 @@ -125,6 +125,9 @@ function New-VSEFSMountTarget { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 b/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 index 3903c0093..f902d070c 100644 --- a/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEKSCluster.ps1 @@ -131,6 +131,9 @@ Cluster creation typically takes between 10 and 15 minutes. After you create an [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 b/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 index 2a04df1f6..eb2fbb138 100644 --- a/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEKSNodegroup.ps1 @@ -283,6 +283,9 @@ Changing this value triggers an update of the node group if one is available. Ho [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 b/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 index 317d3b1e8..a1c109443 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRCluster.ps1 @@ -387,6 +387,9 @@ When you create clusters directly through the EMR console or API, this value is [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 b/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 index 9f04cb9a4..46fecbed0 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRInstanceFleetConfig.ps1 @@ -186,6 +186,9 @@ If not specified or set to 0, only On-Demand instances are provisioned for the i [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 b/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 index 58d5f2558..04fb13a84 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRInstanceGroupConfig.ps1 @@ -225,6 +225,9 @@ The list of configurations supplied for an EMR cluster instance group. You can s [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 index c1526eea2..fcfc90b0d 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRSecurityConfiguration.ps1 @@ -96,6 +96,9 @@ function New-VSEMRSecurityConfiguration { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 b/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 index 2be79670b..d30e684ad 100644 --- a/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEMRStep.ps1 @@ -123,6 +123,9 @@ function New-VSEMRStep { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 index b1431a533..0df72cef0 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheCacheCluster.ps1 @@ -465,6 +465,9 @@ Use this parameter only when you are creating a cluster in an Amazon Virtual Pri [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 index 9452c7f2e..2d007ffb0 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheParameterGroup.ps1 @@ -120,6 +120,9 @@ For example: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 index ba9b5cfaa..374d581c5 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheReplicationGroup.ps1 @@ -648,6 +648,9 @@ For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an Auth [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 index e86d9f867..967869483 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroup.ps1 @@ -84,6 +84,9 @@ Updates are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 index f502d7911..b0e6f28f3 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheSecurityGroupIngress.ps1 @@ -118,6 +118,9 @@ Updates are not supported. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 index c5a8a2dfa..07d7bf36d 100644 --- a/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElastiCacheSubnetGroup.ps1 @@ -109,6 +109,9 @@ Example: mysubnetgroup [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 index e45a6c1e0..39b9117b0 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplication.ps1 @@ -106,6 +106,9 @@ If you specify a name, you cannot perform updates that require replacement of th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 index 188abedbf..69f4858f0 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkApplicationVersion.ps1 @@ -110,6 +110,9 @@ The Amazon S3 bucket must be in the same region as the environment. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 index dc1a5d3bc..f9b169a35 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkConfigurationTemplate.ps1 @@ -189,6 +189,9 @@ Constraint: If both solution stack name and source configuration are specified, [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 index 792f2ca56..3331bc8e8 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticBeanstalkEnvironment.ps1 @@ -253,6 +253,9 @@ Default: If not specified, Elastic Beanstalk attempts to deploy the sample appli [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 index 4ba9002e7..3a065bf48 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingLoadBalancer.ps1 @@ -300,6 +300,9 @@ Update requires replacement if you did not previously specify a subnet or if you [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 index 7c99a5d3b..07b876a1a 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2Listener.ps1 @@ -183,6 +183,9 @@ For more information, see Security Policies: https://docs.aws.amazon.com/elastic [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 index 170d50e96..266e784ec 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerCertificate.ps1 @@ -98,6 +98,9 @@ function New-VSElasticLoadBalancingV2ListenerCertificate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 index cb441035f..00aef7bc9 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2ListenerRule.ps1 @@ -137,6 +137,9 @@ If you try to reorder rules by updating their priorities, do not specify a new p [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 index 5e76ca251..0d5ed1fb4 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2LoadBalancer.ps1 @@ -213,6 +213,9 @@ Network Load Balancers] You can specify subnets from one or more Availability Zo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 index 611e38d74..3d512156b 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticLoadBalancingV2TargetGroup.ps1 @@ -361,6 +361,9 @@ This name must be unique per region per account, can have a maximum of 32 charac [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 b/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 index 21e9f8eda..7806c9fb6 100644 --- a/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSElasticsearchDomain.ps1 @@ -223,6 +223,9 @@ If you set the UpgradeElasticsearchVersion: https://docs.aws.amazon.com/AWSCloud [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 b/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 index b79b7dd50..77bfbd73c 100644 --- a/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventSchemasDiscoverer.ps1 @@ -115,6 +115,9 @@ function New-VSEventSchemasDiscoverer { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 b/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 index 92a4e1763..f17d76424 100644 --- a/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventSchemasRegistry.ps1 @@ -115,6 +115,9 @@ function New-VSEventSchemasRegistry { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 b/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 index 5185eb89c..afc285b36 100644 --- a/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventSchemasSchema.ps1 @@ -169,6 +169,9 @@ function New-VSEventSchemasSchema { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 b/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 index d79d4f8c7..d495c0eac 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsEventBus.ps1 @@ -101,6 +101,9 @@ If you are creating a partner event bus, this name must exactly match the name o [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 index 63af51d87..077bb5ce9 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsEventBusPolicy.ps1 @@ -145,6 +145,9 @@ If you specify "*" without specifying Condition, avoid creating rules that may m [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 b/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 index 980f717c6..b24f6955f 100644 --- a/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSEventsRule.ps1 @@ -217,6 +217,9 @@ If you're setting the event bus of another account as the target and that accoun [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 b/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 index df7b2d414..da33bef55 100644 --- a/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFMSNotificationChannel.ps1 @@ -96,6 +96,9 @@ function New-VSFMSNotificationChannel { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 index fc1ee3f5a..28f34873c 100644 --- a/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFMSPolicy.ps1 @@ -256,6 +256,9 @@ After the cleanup, in-scope resources are no longer protected by web ACLs in thi [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 b/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 index 2cdd3b4db..33fe42d31 100644 --- a/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 +++ b/VaporShell/Public/Resource Types/New-VSFSxFileSystem.ps1 @@ -185,6 +185,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 index 27ee40d4d..e41bc12b7 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftAlias.ps1 @@ -105,6 +105,9 @@ function New-VSGameLiftAlias { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 index 5edcc9f95..e4033ea55 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftBuild.ps1 @@ -123,6 +123,9 @@ function New-VSGameLiftBuild { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 index 1cee5e796..a4eeb7112 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftFleet.ps1 @@ -402,6 +402,9 @@ Note: It is not currently possible to use the !Ref command to reference a script [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 index 130eef7e8..d131b9097 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftGameSessionQueue.ps1 @@ -134,6 +134,9 @@ function New-VSGameLiftGameSessionQueue { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 index 3869f9856..a96f3292e 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingConfiguration.ps1 @@ -287,6 +287,9 @@ function New-VSGameLiftMatchmakingConfiguration { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 index 209c7676b..c90032b37 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftMatchmakingRuleSet.ps1 @@ -96,6 +96,9 @@ function New-VSGameLiftMatchmakingRuleSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 b/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 index 53ebf174d..c99863a0f 100644 --- a/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGameLiftScript.ps1 @@ -105,6 +105,9 @@ function New-VSGameLiftScript { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 b/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 index 46980a352..bf41e6d38 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueClassifier.ps1 @@ -96,6 +96,9 @@ function New-VSGlueClassifier { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 b/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 index 993890290..f52fdca04 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueConnection.ps1 @@ -88,6 +88,9 @@ To specify the account ID, you can use the Ref intrinsic function with the AWS:: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 b/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 index bebb7c01a..5c3bbd0c3 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueCrawler.ps1 @@ -241,6 +241,9 @@ function New-VSGlueCrawler { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 index 1f75ce104..f965c7488 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDataCatalogEncryptionSettings.ps1 @@ -87,6 +87,9 @@ function New-VSGlueDataCatalogEncryptionSettings { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 index 5197c95a2..f53e143bc 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDatabase.ps1 @@ -88,6 +88,9 @@ To specify the account ID, you can use the Ref intrinsic function with the AWS:: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 index f2c882613..4dfd7f702 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueDevEndpoint.ps1 @@ -319,6 +319,9 @@ The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 b/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 index 53b84c5c0..55e00c2eb 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueJob.ps1 @@ -361,6 +361,9 @@ The value that can be allocated for MaxCapacity depends on whether you are runni [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 b/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 index 92338a155..e9dffeec3 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueMLTransform.ps1 @@ -255,6 +255,9 @@ When the WorkerType field is set to a value other than Standard, the MaxCapacity [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 b/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 index f3cb0645d..fc9f49007 100644 --- a/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGluePartition.ps1 @@ -124,6 +124,9 @@ To specify the account ID, you can use the Ref intrinsic function with the AWS:: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 b/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 index 84c94b176..cbf7190dc 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueSecurityConfiguration.ps1 @@ -87,6 +87,9 @@ function New-VSGlueSecurityConfiguration { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 b/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 index 36504bb48..2a3afc795 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueTable.ps1 @@ -105,6 +105,9 @@ function New-VSGlueTable { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 b/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 index f1d6806b8..892f4c711 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueTrigger.ps1 @@ -214,6 +214,9 @@ function New-VSGlueTrigger { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 b/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 index 78c79207a..645b13c4d 100644 --- a/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGlueWorkflow.ps1 @@ -132,6 +132,9 @@ function New-VSGlueWorkflow { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 index 55f20bd1a..991f16fcb 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 index 52ed7980d..844dbb427 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassConnectorDefinitionVersion.ps1 @@ -103,6 +103,9 @@ After you create a connector definition version that contains the connectors you [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 index 07799f7f2..5d5b2ae38 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 index abf0fc240..7f6fb24c0 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassCoreDefinitionVersion.ps1 @@ -103,6 +103,9 @@ After you create a core definition version that contains the core you want to de [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 index 9f948fb41..3e2915f17 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 index c43b79a96..caa3d1648 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassDeviceDefinitionVersion.ps1 @@ -103,6 +103,9 @@ After you create a device definition version that contains the devices you want [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 index 27343d16e..9ddae0957 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 index 0adf79da4..0e3a87988 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassFunctionDefinitionVersion.ps1 @@ -112,6 +112,9 @@ After you create a function definition version that contains the functions you w [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 index 547bb7fbc..952648d25 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassGroup.ps1 @@ -152,6 +152,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 index 43b17e205..206a223c8 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassGroupVersion.ps1 @@ -208,6 +208,9 @@ To create a group version, you must specify the ID of the group that you want to [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 index 864867eb2..9a13e72ee 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 index ba050783c..a82eeea0a 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassLoggerDefinitionVersion.ps1 @@ -103,6 +103,9 @@ After you create a logger definition version that contains the loggers you want [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 index 0c4100323..a3a65af84 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 index 0a8a75825..5137bbb65 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassResourceDefinitionVersion.ps1 @@ -103,6 +103,9 @@ After you create a resource definition version that contains the resources you w [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 index 1c490120a..223d3530a 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinition.ps1 @@ -122,6 +122,9 @@ This Json property type is processed as a map of key-value pairs. It uses the fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 index fbb7906e4..46e2b0a64 100644 --- a/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGreengrassSubscriptionDefinitionVersion.ps1 @@ -103,6 +103,9 @@ After you create a subscription definition version that contains the subscriptio [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 b/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 index cf5ff3c3f..8d70e65ed 100644 --- a/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGroundStationConfig.ps1 @@ -101,6 +101,9 @@ function New-VSGroundStationConfig { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 b/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 index a166644e8..8f1da6460 100644 --- a/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGroundStationDataflowEndpointGroup.ps1 @@ -86,6 +86,9 @@ function New-VSGroundStationDataflowEndpointGroup { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 b/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 index 2a2d4439a..4fe52d858 100644 --- a/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGroundStationMissionProfile.ps1 @@ -166,6 +166,9 @@ function New-VSGroundStationMissionProfile { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 index 61fbef6cd..23cbbf00e 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyDetector.ps1 @@ -96,6 +96,9 @@ function New-VSGuardDutyDetector { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 index d97f7dc71..3424271ca 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyFilter.ps1 @@ -159,6 +159,9 @@ function New-VSGuardDutyFilter { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 index f4e4bf58a..9129e2e76 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyIPSet.ps1 @@ -150,6 +150,9 @@ function New-VSGuardDutyIPSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 index 9b77625bb..4d68e0e06 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyMaster.ps1 @@ -114,6 +114,9 @@ function New-VSGuardDutyMaster { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 index d48ee3b20..296e8d5ac 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyMember.ps1 @@ -168,6 +168,9 @@ function New-VSGuardDutyMember { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 b/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 index 418b77285..bc726aac7 100644 --- a/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSGuardDutyThreatIntelSet.ps1 @@ -150,6 +150,9 @@ function New-VSGuardDutyThreatIntelSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 b/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 index 6e8c5319c..962c7b828 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMAccessKey.ps1 @@ -123,6 +123,9 @@ This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 b/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 index 5b3604828..1007c5311 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMGroup.ps1 @@ -138,6 +138,9 @@ For information about limits on the number of inline policies that you can embed [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 b/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 index d4de15b7f..e2094e021 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMInstanceProfile.ps1 @@ -112,6 +112,9 @@ This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 index 33d7ccbbd..4744fbba6 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMManagedPolicy.ps1 @@ -186,6 +186,9 @@ This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 index acfe89912..9cf5d6ffe 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMPolicy.ps1 @@ -145,6 +145,9 @@ This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 b/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 index 7b5a7392e..872c61cbd 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMRole.ps1 @@ -224,6 +224,9 @@ Naming an IAM resource can cause an unrecoverable error if you reuse the same te [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 b/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 index 046c555d1..453949dca 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMServiceLinkedRole.ps1 @@ -118,6 +118,9 @@ Service principals are unique and case-sensitive. To find the exact service prin [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 b/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 index b381a85c9..d21414af7 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMUser.ps1 @@ -189,6 +189,9 @@ Naming an IAM resource can cause an unrecoverable error if you reuse the same te [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 b/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 index 6388071b9..5dc14ff53 100644 --- a/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIAMUserToGroupAddition.ps1 @@ -90,6 +90,9 @@ This parameter allows through its regex pattern: http://wikipedia.org/wiki/regex [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 index 33d58a1f7..9b3599400 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTarget.ps1 @@ -96,6 +96,9 @@ function New-VSInspectorAssessmentTarget { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 index c84bd1eae..004bc13e2 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorAssessmentTemplate.ps1 @@ -135,6 +135,9 @@ function New-VSInspectorAssessmentTemplate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 b/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 index c450efa4e..b6f749387 100644 --- a/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSInspectorResourceGroup.ps1 @@ -72,6 +72,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 b/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 index 4fc0cb5f7..654841b8b 100644 --- a/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoT1ClickDevice.ps1 @@ -96,6 +96,9 @@ function New-VSIoT1ClickDevice { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 b/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 index b77171c53..6fc6d4abe 100644 --- a/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoT1ClickPlacement.ps1 @@ -132,6 +132,9 @@ function New-VSIoT1ClickPlacement { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 b/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 index bc22dbd13..e395dd4de 100644 --- a/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoT1ClickProject.ps1 @@ -105,6 +105,9 @@ function New-VSIoT1ClickProject { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 index 383ba8a37..9fef4f5c2 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsChannel.ps1 @@ -108,6 +108,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 index 167579565..0c682324d 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDataset.ps1 @@ -165,6 +165,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 index 91db86b98..a39fa0041 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsDatastore.ps1 @@ -108,6 +108,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 index 3a5afb5fd..a8839e681 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTAnalyticsPipeline.ps1 @@ -111,6 +111,9 @@ pipelineActivities = { "channel": { ... } }, { "lambda": { ... } }, ... ] [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 b/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 index 5adb681b0..0570415d1 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTCertificate.ps1 @@ -98,6 +98,9 @@ The status value REGISTER_INACTIVE is deprecated and should not be used. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 b/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 index 731d8b76f..ac01d80f6 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTEventsDetectorModel.ps1 @@ -181,6 +181,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 b/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 index 09ad0b3ce..4847037e0 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTEventsInput.ps1 @@ -117,6 +117,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 index 6e08590ee..6f02808f0 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTPolicy.ps1 @@ -96,6 +96,9 @@ function New-VSIoTPolicy { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 index a6ad53707..19c1dd44c 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTPolicyPrincipalAttachment.ps1 @@ -98,6 +98,9 @@ For information about working with AWS IoT policies and principals, see Authoriz [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 b/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 index 7551a1fc1..e518e9f8a 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTThing.ps1 @@ -89,6 +89,9 @@ For information about working with things, see How AWS IoT Works: https://docs.a [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 index 2603aca0e..33f5bb340 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTThingPrincipalAttachment.ps1 @@ -98,6 +98,9 @@ For more information about working with AWS IoT things and principals, see Autho [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 index 205ca6f5d..27bdeefcd 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTThingsGraphFlowTemplate.ps1 @@ -87,6 +87,9 @@ function New-VSIoTThingsGraphFlowTemplate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 b/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 index 22da7b2cb..7ca6e3231 100644 --- a/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSIoTTopicRule.ps1 @@ -87,6 +87,9 @@ function New-VSIoTTopicRule { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 b/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 index ef2ec5916..427d0c96f 100644 --- a/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKMSAlias.ps1 @@ -108,6 +108,9 @@ When specifying an alias, observe the following rules. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 b/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 index 3f3eac25d..c318487e4 100644 --- a/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKMSKey.ps1 @@ -200,6 +200,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 index 6a8bc46dd..1ef075821 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplication.ps1 @@ -138,6 +138,9 @@ Note that the application code must create the streams with names specified in t [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 index f3a8ceec6..6dbbc7584 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationOutput.ps1 @@ -97,6 +97,9 @@ This operation requires permissions to perform the kinesisanalytics:AddApplicati [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 index 1e87e560a..a154c32bb 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsApplicationReferenceDataSource.ps1 @@ -93,6 +93,9 @@ This operation requires permissions to perform the kinesisanalytics:AddApplicati [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 index 783b8cb8a..b3c4ee4ce 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2Application.ps1 @@ -141,6 +141,9 @@ function New-VSKinesisAnalyticsV2Application { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 index 826b994fc..3f124b3a1 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption.ps1 @@ -87,6 +87,9 @@ function New-VSKinesisAnalyticsV2ApplicationCloudWatchLoggingOption { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 index 3b3b94e14..e72fbb123 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationOutput.ps1 @@ -93,6 +93,9 @@ Any configuration update, including adding a streaming source using this operati [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 index d78cf5d0f..127809c38 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisAnalyticsV2ApplicationReferenceDataSource.ps1 @@ -89,6 +89,9 @@ Kinesis Data Analytics reads reference data (that is, an Amazon S3 object and cr [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 index 527a82539..41a5ccac1 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisFirehoseDeliveryStream.ps1 @@ -160,6 +160,9 @@ If you change the delivery stream destination from an Amazon S3 destination to a [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 index 52a7a2156..d73195db4 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisStream.ps1 @@ -136,6 +136,9 @@ If you specify a name, you cannot perform updates that require replacement of th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 b/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 index c4dd9b510..eda38be80 100644 --- a/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSKinesisStreamConsumer.ps1 @@ -100,6 +100,9 @@ For more information, see Using Consumers with Enhanced Fan-Out: https://docs.aw [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 b/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 index 71189c6f3..da86f3855 100644 --- a/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLakeFormationDataLakeSettings.ps1 @@ -69,6 +69,9 @@ function New-VSLakeFormationDataLakeSettings { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 b/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 index 59e3ed3d1..1b714b96e 100644 --- a/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLakeFormationPermissions.ps1 @@ -98,6 +98,9 @@ function New-VSLakeFormationPermissions { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 b/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 index dee921f4e..89b51820e 100644 --- a/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLakeFormationResource.ps1 @@ -114,6 +114,9 @@ function New-VSLakeFormationResource { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 index aef18f50e..c982e3074 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaAlias.ps1 @@ -157,6 +157,9 @@ The length constraint applies only to the full ARN. If you specify only the func [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 index 6f7deef5f..da7f8c45b 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaEventInvokeConfig.ps1 @@ -154,6 +154,9 @@ By default, Lambda retries an asynchronous invocation twice if the function retu [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 index b5126f96d..10a76f72b 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaEventSourceMapping.ps1 @@ -271,6 +271,9 @@ The length constraint applies only to the full ARN. If you specify only the func [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 index c2ef0d0dc..ba5b7387e 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaFunction.ps1 @@ -291,6 +291,9 @@ If you specify a name, you cannot perform updates that require replacement of th [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 index b13f76c53..811e922da 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersion.ps1 @@ -136,6 +136,9 @@ function New-VSLambdaLayerVersion { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 index 0c9769b0f..c4e1154fb 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaLayerVersionPermission.ps1 @@ -132,6 +132,9 @@ function New-VSLambdaLayerVersionPermission { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 index 9e4fa49fc..7566afc8c 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaPermission.ps1 @@ -177,6 +177,9 @@ You can append a version number or alias to any of the formats. The length const [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 b/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 index 69cea5c29..75db41fe8 100644 --- a/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLambdaVersion.ps1 @@ -128,6 +128,9 @@ The length constraint applies only to the full ARN. If you specify only the func [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 b/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 index 708e5e774..a3b755d21 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsDestination.ps1 @@ -132,6 +132,9 @@ function New-VSLogsDestination { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 b/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 index a3da26ad2..699dae778 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsLogGroup.ps1 @@ -108,6 +108,9 @@ If you attempt to associate a CMK with the log group but the CMK doesn't exist o [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 b/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 index d6cca1138..1acc3f951 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsLogStream.ps1 @@ -106,6 +106,9 @@ You must use the following guidelines when naming a log stream: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 b/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 index 480896cad..f28ccc5d1 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsMetricFilter.ps1 @@ -118,6 +118,9 @@ The maximum number of metric filters that can be associated with a log group is [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 b/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 index 03b791550..a30de21b3 100644 --- a/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSLogsSubscriptionFilter.ps1 @@ -142,6 +142,9 @@ There can only be one subscription filter associated with a log group. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 b/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 index 6c21e2ac3..97d1b4907 100644 --- a/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMSKCluster.ps1 @@ -195,6 +195,9 @@ function New-VSMSKCluster { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 b/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 index 7756fb9b9..39db0ea1e 100644 --- a/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 +++ b/VaporShell/Public/Resource Types/New-VSManagedBlockchainMember.ps1 @@ -114,6 +114,9 @@ function New-VSManagedBlockchainMember { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 b/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 index ff5381195..da5314145 100644 --- a/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 +++ b/VaporShell/Public/Resource Types/New-VSManagedBlockchainNode.ps1 @@ -105,6 +105,9 @@ function New-VSManagedBlockchainNode { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 index 3b896850d..7f3fe03f2 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaConvertJobTemplate.ps1 @@ -235,6 +235,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 b/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 index 3760c2602..2b13be293 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaConvertPreset.ps1 @@ -156,6 +156,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 b/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 index d10779705..5f1920b42 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaConvertQueue.ps1 @@ -152,6 +152,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 b/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 index 761ccc6ea..01584cbf5 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaLiveChannel.ps1 @@ -217,6 +217,9 @@ A MediaLive channel ingests and transcodes (decodes and encodes source content f [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 b/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 index 7257a3bf5..530436fe5 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaLiveInput.ps1 @@ -210,6 +210,9 @@ A MediaLive input holds information that describes how the MediaLive channel is [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 index 4756c6abf..b9589a8dd 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaLiveInputSecurityGroup.ps1 @@ -99,6 +99,9 @@ A MediaLive input security group is associated with a MediaLive input. The input [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 b/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 index cafbbe6dc..932ae2170 100644 --- a/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSMediaStoreContainer.ps1 @@ -157,6 +157,9 @@ For information about how to construct an object lifecycle policy, see Component [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 index 5c3a4f817..246282e52 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBCluster.ps1 @@ -350,6 +350,9 @@ An update may require some interruption. See ModifyDBInstance: https://docs.aws. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 index b85cbb6cb..b7de266bc 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBClusterParameterGroup.ps1 @@ -149,6 +149,9 @@ If you update the parameters, some interruption may occur depending on which par [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 index d35c64501..07bf2ef4a 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBInstance.ps1 @@ -283,6 +283,9 @@ AWS::Neptune::DBCluster does support restoring from snapshots. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 index c89871937..1dc4bd80a 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBParameterGroup.ps1 @@ -155,6 +155,9 @@ Changes to dynamic parameters are applied immediately. During an update, if you [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 index 11ae88fbc..f2e7e53ea 100644 --- a/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSNeptuneDBSubnetGroup.ps1 @@ -117,6 +117,9 @@ function New-VSNeptuneDBSubnetGroup { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 index 9b69673aa..de88f3b29 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksApp.ps1 @@ -253,6 +253,9 @@ If you have specified one or more environment variables, you cannot modify the s [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 index f6a689668..74f1b474d 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksCMServer.ps1 @@ -443,6 +443,9 @@ For more information about supported Amazon EC2 platforms, see Supported Platfor [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 index 5349068aa..d1cead49b 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksElasticLoadBalancerAttachment.ps1 @@ -96,6 +96,9 @@ function New-VSOpsWorksElasticLoadBalancerAttachment { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 index 75bcc1a67..7b60a1ff9 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksInstance.ps1 @@ -425,6 +425,9 @@ The default option is the current Amazon Linux version. If you set this paramete [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 index 4478a232d..8691002b5 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksLayer.ps1 @@ -360,6 +360,9 @@ The built-in layers' short names are defined by AWS OpsWorks Stacks. For more in [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 index 7cb168d92..6336823e4 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksStack.ps1 @@ -514,6 +514,9 @@ For more information about how to use AWS OpsWorks Stacks with a VPC, see Runnin [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 index 17d793752..92bf0220f 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksUserProfile.ps1 @@ -132,6 +132,9 @@ function New-VSOpsWorksUserProfile { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 b/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 index 0526fe92b..c55f3a24c 100644 --- a/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 +++ b/VaporShell/Public/Resource Types/New-VSOpsWorksVolume.ps1 @@ -132,6 +132,9 @@ function New-VSOpsWorksVolume { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 index 6c9eb0263..fe8daa1b4 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointADMChannel.ps1 @@ -134,6 +134,9 @@ The AWS::Pinpoint::ADMChannel resource defines the status and authentication set [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 index 36dba35dd..5fa099b70 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSChannel.ps1 @@ -224,6 +224,9 @@ The AWS::Pinpoint::APNSChannel resource defines the status and authentication se [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 index 7a5de0b6a..688294f20 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSSandboxChannel.ps1 @@ -224,6 +224,9 @@ The AWS::Pinpoint::APNSSandboxChannel resource defines the status and authentica [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 index 2f4c6204a..c90940258 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipChannel.ps1 @@ -224,6 +224,9 @@ The AWS::Pinpoint::APNSVoipChannel resource defines the status and authenticatio [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 index a817307c9..76ee5331d 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointAPNSVoipSandboxChannel.ps1 @@ -224,6 +224,9 @@ The AWS::Pinpoint::APNSVoipSandboxChannel resource defines the status and authen [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 index 98a3ad37f..391687b4b 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointApp.ps1 @@ -96,6 +96,9 @@ function New-VSPinpointApp { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 index f6c3ffdb6..1491488f8 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointApplicationSettings.ps1 @@ -128,6 +128,9 @@ You can override the default quiet time settings for a specific campaign or jour [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 index 17e6a181a..40b38d68a 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointBaiduChannel.ps1 @@ -134,6 +134,9 @@ The AWS::Pinpoint::BaiduChannel resource defines the status and authentication s [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 index 1a42521a4..c23acc4bb 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointCampaign.ps1 @@ -295,6 +295,9 @@ function New-VSPinpointCampaign { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 index c1d45bd82..2f7e6da50 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailChannel.ps1 @@ -170,6 +170,9 @@ The AWS::Pinpoint::EmailChannel resource defines the status, identity, and other [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 index f5de8393b..0d56cd137 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSet.ps1 @@ -133,6 +133,9 @@ function New-VSPinpointEmailConfigurationSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 index e1f54a10d..78119d6df 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailConfigurationSetEventDestination.ps1 @@ -107,6 +107,9 @@ A single configuration set can include more than one event destination. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 index 5c62d793e..a4ef91623 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailDedicatedIpPool.ps1 @@ -97,6 +97,9 @@ function New-VSPinpointEmailDedicatedIpPool { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 index bf3cd5f71..75a4a9052 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailIdentity.ps1 @@ -153,6 +153,9 @@ If the value is true, then the messages that you send from the domain are signed [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 index 7a5cda534..189c6e04c 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEmailTemplate.ps1 @@ -186,6 +186,9 @@ function New-VSPinpointEmailTemplate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 index 5c2990101..ca5895885 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointEventStream.ps1 @@ -118,6 +118,9 @@ For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 index ddc1b4fee..f9f0efc3b 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointGCMChannel.ps1 @@ -116,6 +116,9 @@ The AWS::Pinpoint::GCMChannel resource defines the status and authentication set [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 index 14d479bab..d18feb70f 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointPushTemplate.ps1 @@ -177,6 +177,9 @@ function New-VSPinpointPushTemplate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 index b98d2ee4a..8395dc981 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSMSChannel.ps1 @@ -136,6 +136,9 @@ SenderIDs are only supported in certain countries and regions. For more informat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 index 0c625f8cf..770d35dc3 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSegment.ps1 @@ -132,6 +132,9 @@ function New-VSPinpointSegment { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 index 4a75e522a..284f71f21 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointSmsTemplate.ps1 @@ -150,6 +150,9 @@ function New-VSPinpointSmsTemplate { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 b/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 index 0822b9224..a2ea5a4bb 100644 --- a/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSPinpointVoiceChannel.ps1 @@ -98,6 +98,9 @@ The AWS::Pinpoint::VoiceChannel resource defines the status and other settings o [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 b/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 index eedf304fe..fb59613c6 100644 --- a/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 +++ b/VaporShell/Public/Resource Types/New-VSQLDBLedger.ps1 @@ -129,6 +129,9 @@ For more information, see Tag: https://docs.aws.amazon.com/AWSCloudFormation/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 b/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 index 2611eb66c..1bfa14c32 100644 --- a/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRAMResourceShare.ps1 @@ -127,6 +127,9 @@ function New-VSRAMResourceShare { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 index a93b65457..4177d0673 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBCluster.ps1 @@ -636,6 +636,9 @@ If you specify the KmsKeyId property, then you must enable encryption. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 index 9bdad7ec2..01b280ffa 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBClusterParameterGroup.ps1 @@ -135,6 +135,9 @@ For more information, see CreateDBClusterParameterGroup: https://docs.aws.amazon [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 index b20801bf3..6b0228c4c 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBInstance.ps1 @@ -1196,6 +1196,9 @@ To avoid this situation, migrate your DB instance to using VPC security groups o [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 index 1c2457f90..f74d3ffec 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBParameterGroup.ps1 @@ -136,6 +136,9 @@ Valid Values for Apply method: pending-reboot [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 index d62411d0e..5bc91a7d0 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroup.ps1 @@ -135,6 +135,9 @@ The EC2VpcId property is for backward compatibility with older regions, and is n [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 index bf77dd0f0..c410ea421 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSecurityGroupIngress.ps1 @@ -154,6 +154,9 @@ For details about the settings for DB security group ingress, see AuthorizeDBSec [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 index adb898668..df9a1ddf8 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSDBSubnetGroup.ps1 @@ -121,6 +121,9 @@ Example: mySubnetgroup [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 index 3b6276d59..b5c6aaaa2 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSEventSubscription.ps1 @@ -143,6 +143,9 @@ Valid values: db-instance | db-cluster | db-parameter-group | db-security-group [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 index 288447836..c5e3fe912 100644 --- a/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRDSOptionGroup.ps1 @@ -146,6 +146,9 @@ function New-VSRDSOptionGroup { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 index 01bda857b..b2c6f9ad2 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftCluster.ps1 @@ -611,6 +611,9 @@ Default: The default VPC security group is associated with the cluster. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 index 1416a78f6..08fa269e7 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterParameterGroup.ps1 @@ -130,6 +130,9 @@ For the workload management WLM configuration, you must supply all the name-valu [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 index bbc8ed19f..42f851e67 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroup.ps1 @@ -92,6 +92,9 @@ For information about managing security groups, go to Amazon Redshift Cluster Se [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 index d5015dc17..bf4b40a01 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSecurityGroupIngress.ps1 @@ -140,6 +140,9 @@ Conditional. If you specify the EC2SecurityGroupName property, you must specify [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 index a8dc9b573..39634e028 100644 --- a/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRedshiftClusterSubnetGroup.ps1 @@ -103,6 +103,9 @@ For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 index 869fea86f..15ea75b90 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerFleet.ps1 @@ -96,6 +96,9 @@ function New-VSRoboMakerFleet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 index f2870c452..4c22093a0 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobot.ps1 @@ -150,6 +150,9 @@ function New-VSRoboMakerRobot { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 index 74bc2b178..8cceec27d 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplication.ps1 @@ -142,6 +142,9 @@ function New-VSRoboMakerRobotApplication { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 index 191121a64..ce40d4228 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerRobotApplicationVersion.ps1 @@ -96,6 +96,9 @@ function New-VSRoboMakerRobotApplicationVersion { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 index a3e2034f2..fcd03b211 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplication.ps1 @@ -160,6 +160,9 @@ function New-VSRoboMakerSimulationApplication { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 index 9d3a04aea..54156dc63 100644 --- a/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoboMakerSimulationApplicationVersion.ps1 @@ -96,6 +96,9 @@ function New-VSRoboMakerSimulationApplicationVersion { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 index d7d0feae8..ea2cf87bb 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53HealthCheck.ps1 @@ -105,6 +105,9 @@ You can associate health checks with failover records in a private hosted zone. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 index 771a8cce1..d5975aade 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53HostedZone.ps1 @@ -201,6 +201,9 @@ For public hosted zones, omit VPCs, VPCId, and VPCRegion. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 index bb3c99cf1..0a1394f80 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53RecordSet.ps1 @@ -419,6 +419,9 @@ The effect of setting Weight to 0 is different when you associate health checks [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 index 472ba1dc3..7383f7466 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53RecordSetGroup.ps1 @@ -137,6 +137,9 @@ Specify either HostedZoneName or HostedZoneId, but not both. If you have multipl [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 index 8d18bbbf8..ab8210eec 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverEndpoint.ps1 @@ -142,6 +142,9 @@ function New-VSRoute53ResolverResolverEndpoint { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 index 44670eee3..99b69a14e 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRule.ps1 @@ -164,6 +164,9 @@ For example, to forward DNS queries for example.com to resolvers on your network [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 index 56ef7a4a1..0e296c0c3 100644 --- a/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSRoute53ResolverResolverRuleAssociation.ps1 @@ -114,6 +114,9 @@ function New-VSRoute53ResolverResolverRuleAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 b/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 index 38873f114..a62a2bfdf 100644 --- a/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3AccessPoint.ps1 @@ -186,6 +186,9 @@ function New-VSS3AccessPoint { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 b/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 index a286eead1..9f24daddb 100644 --- a/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3Bucket.ps1 @@ -297,6 +297,9 @@ Amazon S3 can store replicated objects in only one destination bucket. The desti [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 index 3735928af..724a6d1a2 100644 --- a/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSS3BucketPolicy.ps1 @@ -114,6 +114,9 @@ The following operations are related to PutBucketPolicy: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 b/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 index e025e10c5..c1e79cafa 100644 --- a/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSDBDomain.ps1 @@ -82,6 +82,9 @@ The AWS::SDB::Domain resource does not allow any updates, including metadata upd [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 b/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 index fa5273634..2a1acaf79 100644 --- a/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESConfigurationSet.ps1 @@ -80,6 +80,9 @@ function New-VSSESConfigurationSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 b/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 index d376f9527..2ed7dc22d 100644 --- a/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESConfigurationSetEventDestination.ps1 @@ -91,6 +91,9 @@ You can't specify Amazon SNS event destinations in CloudFormation templates. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 b/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 index aa81ff963..bcdef8207 100644 --- a/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESReceiptFilter.ps1 @@ -69,6 +69,9 @@ function New-VSSESReceiptFilter { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 b/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 index 67182ab5b..aa023261f 100644 --- a/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESReceiptRule.ps1 @@ -109,6 +109,9 @@ You can execute this operation no more than once per second. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 b/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 index d3fb0fb5d..ec48d0490 100644 --- a/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESReceiptRuleSet.ps1 @@ -82,6 +82,9 @@ You can execute this operation no more than once per second. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 b/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 index 84a68f727..2942f6a0d 100644 --- a/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSESTemplate.ps1 @@ -71,6 +71,9 @@ You can execute this operation no more than once per second. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 b/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 index b8bca5a95..d6c03694b 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSSubscription.ps1 @@ -208,6 +208,9 @@ If you perform an update operation that only updates the Region property of a AW [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 b/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 index 44a47317f..435bb5369 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSTopic.ps1 @@ -154,6 +154,9 @@ If you specify a name, you can't perform updates that require replacement of thi [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 index cba89e542..5fc74aa0c 100644 --- a/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSNSTopicPolicy.ps1 @@ -89,6 +89,9 @@ function New-VSSNSTopicPolicy { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 b/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 index cf69bb515..be5a38450 100644 --- a/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSQSQueue.ps1 @@ -302,6 +302,9 @@ For more information about Amazon SQS queue visibility timeouts, see Visibility [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 index f1b06ecad..2ca2f7459 100644 --- a/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSQSQueuePolicy.ps1 @@ -89,6 +89,9 @@ function New-VSSQSQueuePolicy { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 index 51c8e1998..d7e19fd97 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMAssociation.ps1 @@ -200,6 +200,9 @@ InstanceId has been deprecated. To specify an instance ID for an association, us [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 b/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 index dafdd2001..564834868 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMDocument.ps1 @@ -135,6 +135,9 @@ Do not use the following to begin the names of documents you create. They are re [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 index 4d28b4e17..a897beb09 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindow.ps1 @@ -235,6 +235,9 @@ For more information, see Systems Manager Maintenance Windows: https://docs.aws. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 index 10348616d..d02933e30 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTarget.ps1 @@ -170,6 +170,9 @@ You must specify targets by using the WindowTargetIds parameter. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 index 7a8388a7c..8d7251d01 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMMaintenanceWindowTask.ps1 @@ -284,6 +284,9 @@ LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instea [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 b/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 index 1cd018a64..21813faf7 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMParameter.ps1 @@ -215,6 +215,9 @@ Working with Parameter Policies: https://docs.aws.amazon.com/systems-manager/lat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 b/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 index 09e48e93b..0c1b357ea 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMPatchBaseline.ps1 @@ -252,6 +252,9 @@ For information about accepted formats for lists of approved patches and rejecte [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 b/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 index 263ab7c40..e0dfd95e1 100644 --- a/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSSMResourceDataSync.ps1 @@ -216,6 +216,9 @@ Important: The following *Syntax* section shows all fields that are supported fo [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 index 37a525ae1..45e874e7d 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerCodeRepository.ps1 @@ -89,6 +89,9 @@ The repository can be hosted either in AWS CodeCommit: https://docs.aws.amazon.c [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 index b65711e3e..061493ef4 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerEndpoint.ps1 @@ -145,6 +145,9 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 index 898f7eef1..84cf1610f 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerEndpointConfig.ps1 @@ -136,6 +136,9 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 index 3d4f0087e..f868eb076 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerModel.ps1 @@ -146,6 +146,9 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 index 6f637948d..98259878d 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstance.ps1 @@ -286,6 +286,9 @@ You can add tags later by using the CreateTags API. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 index ad58124db..af0754139 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerNotebookInstanceLifecycleConfig.ps1 @@ -116,6 +116,9 @@ function New-VSSageMakerNotebookInstanceLifecycleConfig { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 b/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 index 1d604ea7e..d7299c797 100644 --- a/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSageMakerWorkteam.ps1 @@ -138,6 +138,9 @@ For more information, see Resource Tag: https://docs.aws.amazon.com/AWSCloudForm [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 index aba31c2fd..d00002db2 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerResourcePolicy.ps1 @@ -97,6 +97,9 @@ If you use this property to change the SecretId for an existing resource-based p [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 index d7981303f..3ac37e7b1 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerRotationSchedule.ps1 @@ -109,6 +109,9 @@ When you configure rotation for a secret, AWS CloudFormation automatically rotat [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 index 94ff8d82b..9f03824af 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecret.ps1 @@ -175,6 +175,9 @@ Either SecretString or GenerateSecretString must have a value, but not both. The [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 index 04d623695..2441392b5 100644 --- a/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecretsManagerSecretTargetAttachment.ps1 @@ -125,6 +125,9 @@ function New-VSSecretsManagerSecretTargetAttachment { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 b/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 index 16a0c124d..85aa5dafd 100644 --- a/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 +++ b/VaporShell/Public/Resource Types/New-VSSecurityHubHub.ps1 @@ -78,6 +78,9 @@ function New-VSSecurityHubHub { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 index 0b9cd21a2..3d501c1b7 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogAcceptedPortfolioShare.ps1 @@ -99,6 +99,9 @@ function New-VSServiceCatalogAcceptedPortfolioShare { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 index 91a02e237..c43082b4f 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProduct.ps1 @@ -237,6 +237,9 @@ function New-VSServiceCatalogCloudFormationProduct { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 index bc655ad13..74df2d45c 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogCloudFormationProvisionedProduct.ps1 @@ -248,6 +248,9 @@ You must specify either the ID or the name of the provisioning artifact, but not [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 index f80a3096f..1616d6acf 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchNotificationConstraint.ps1 @@ -145,6 +145,9 @@ function New-VSServiceCatalogLaunchNotificationConstraint { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 index 07db71105..0ce6e6c62 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchRoleConstraint.ps1 @@ -153,6 +153,9 @@ function New-VSServiceCatalogLaunchRoleConstraint { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 index 65a883143..e978b2ba4 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogLaunchTemplateConstraint.ps1 @@ -153,6 +153,9 @@ function New-VSServiceCatalogLaunchTemplateConstraint { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 index e39acaad6..240ab0d82 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolio.ps1 @@ -146,6 +146,9 @@ function New-VSServiceCatalogPortfolio { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 index fa8c0692d..ca9565816 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioPrincipalAssociation.ps1 @@ -135,6 +135,9 @@ function New-VSServiceCatalogPortfolioPrincipalAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 index fadabf7e5..9750cb73e 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioProductAssociation.ps1 @@ -135,6 +135,9 @@ function New-VSServiceCatalogPortfolioProductAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 index b7a53c2ed..d907ecf11 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogPortfolioShare.ps1 @@ -117,6 +117,9 @@ function New-VSServiceCatalogPortfolioShare { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 index ae6f44283..4c2e913a4 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogResourceUpdateConstraint.ps1 @@ -154,6 +154,9 @@ If set to NOT_ALLOWED, prevents users from changing tags in a CloudFormationProv [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 index 280f49f9c..19fa142e7 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogStackSetConstraint.ps1 @@ -212,6 +212,9 @@ If no values are specified, the default value is all regions from the STACKSET c [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 index 6dd80fe0c..fde247012 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOption.ps1 @@ -114,6 +114,9 @@ function New-VSServiceCatalogTagOption { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 index d278db74d..10a144eec 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceCatalogTagOptionAssociation.ps1 @@ -96,6 +96,9 @@ function New-VSServiceCatalogTagOptionAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 index 5a92d2409..40c0b7095 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryHttpNamespace.ps1 @@ -98,6 +98,9 @@ For the current limit on the number of namespaces that you can create using the [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 index f811f11ab..8a2b3a383 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryInstance.ps1 @@ -145,6 +145,9 @@ The health check isn't deleted immediately, so it will still appear for a while [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 index f8ae99e46..a507cf38c 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPrivateDnsNamespace.ps1 @@ -114,6 +114,9 @@ function New-VSServiceDiscoveryPrivateDnsNamespace { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 index 303cad84d..9a4f23b54 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryPublicDnsNamespace.ps1 @@ -96,6 +96,9 @@ function New-VSServiceDiscoveryPublicDnsNamespace { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 index d8700a042..82e53f1cf 100644 --- a/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 +++ b/VaporShell/Public/Resource Types/New-VSServiceDiscoveryService.ps1 @@ -158,6 +158,9 @@ For information about the charges for health checks, see Amazon Route 53 Pricing [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 b/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 index f417d336d..637d0c6aa 100644 --- a/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 +++ b/VaporShell/Public/Resource Types/New-VSStepFunctionsActivity.ps1 @@ -107,6 +107,9 @@ For an EXPRESS state machine, the name should only contain 0-9, A-Z, a-z, - and [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 b/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 index d7d14f124..4d1154a89 100644 --- a/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 +++ b/VaporShell/Public/Resource Types/New-VSStepFunctionsStateMachine.ps1 @@ -169,6 +169,9 @@ Tags may only contain Unicode letters, digits, white space, or these symbols: _ [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 b/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 index 2986b27ca..855efe76a 100644 --- a/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 +++ b/VaporShell/Public/Resource Types/New-VSTransferServer.ps1 @@ -144,6 +144,9 @@ It is recommended that you use VPC as the EndpointType. With this endpoint type, [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 b/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 index e6ea9b34a..d6972367a 100644 --- a/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 +++ b/VaporShell/Public/Resource Types/New-VSTransferUser.ps1 @@ -224,6 +224,9 @@ If the target of a logical directory entry does not exist in S3, the entry will [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 index 01172df1c..b800677f8 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFByteMatchSet.ps1 @@ -98,6 +98,9 @@ function New-VSWAFByteMatchSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 index 48df99073..9265d9b5f 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFIPSet.ps1 @@ -106,6 +106,9 @@ To specify an individual IP address, you specify the four-part IP address follow [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 index 19bf625fc..dbc833f7e 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalByteMatchSet.ps1 @@ -97,6 +97,9 @@ function New-VSWAFRegionalByteMatchSet { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 index b28acfb94..90a87a79f 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalGeoMatchSet.ps1 @@ -103,6 +103,9 @@ Contains one or more countries that AWS WAF will search for. [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 index b13326e71..4b396a5a2 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalIPSet.ps1 @@ -105,6 +105,9 @@ To specify an individual IP address, you specify the four-part IP address follow [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 index 0b1edefa9..d41d8ce96 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRateBasedRule.ps1 @@ -161,6 +161,9 @@ Note you can only create rate-based rules using a CloudFormation template. To ad [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 index 7bde91bcb..e28afac8b 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRegexPatternSet.ps1 @@ -90,6 +90,9 @@ Note that you can only create regex pattern sets using a CloudFormation template [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 index 213babb9e..b0170b515 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalRule.ps1 @@ -121,6 +121,9 @@ To match the settings in this Rule, a request must originate from 192.0.2.44 AND [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 index b276194d0..518d94600 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalSizeConstraintSet.ps1 @@ -103,6 +103,9 @@ A complex type that contains SizeConstraint objects, which specify the parts of [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 index 877cb6283..2d1549c96 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalSqlInjectionMatchSet.ps1 @@ -103,6 +103,9 @@ A complex type that contains SqlInjectionMatchTuple objects, which specify the p [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 index 03338883b..9b4ca7281 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACL.ps1 @@ -124,6 +124,9 @@ function New-VSWAFRegionalWebACL { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 index 7a0af0817..8ed1dac98 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalWebACLAssociation.ps1 @@ -96,6 +96,9 @@ function New-VSWAFRegionalWebACLAssociation { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 index e1fa8f679..1dc5d171e 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRegionalXssMatchSet.ps1 @@ -103,6 +103,9 @@ A complex type that contains XssMatchTuple objects, which specify the parts of w [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 b/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 index 5426c7f6d..a3ffd44b5 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFRule.ps1 @@ -122,6 +122,9 @@ To match the settings in this Rule, a request must originate from 192.0.2.44 AND [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 index 7b1d7e354..ed62b2484 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFSizeConstraintSet.ps1 @@ -104,6 +104,9 @@ A complex type that contains SizeConstraint objects, which specify the parts of [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 index b8f1e11af..d192903f8 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFSqlInjectionMatchSet.ps1 @@ -104,6 +104,9 @@ A complex type that contains SqlInjectionMatchTuple objects, which specify the p [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 index 5259bf9f5..cc00f29fc 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFWebACL.ps1 @@ -125,6 +125,9 @@ function New-VSWAFWebACL { [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 index 7663a573d..5906fc459 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFXssMatchSet.ps1 @@ -104,6 +104,9 @@ A complex type that contains XssMatchTuple objects, which specify the parts of w [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 index 171182c93..954572357 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2IPSet.ps1 @@ -165,6 +165,9 @@ For more information about CIDR notation, see the Wikipedia entry Classless Inte [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 index 4ac05db04..a78ad1b93 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2RegexPatternSet.ps1 @@ -141,6 +141,9 @@ You use a regex pattern set by providing its Amazon Resource Name (ARN to the ru [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 index dd43aef72..0a7d08d55 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2RuleGroup.ps1 @@ -179,6 +179,9 @@ AWS WAF uses WCUs to calculate and control the operating resources that are used [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 index 38c5fc767..d6936bcb7 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2WebACL.ps1 @@ -166,6 +166,9 @@ Use an AWS::WAFv2::WebACL: #aws-resource-wafv2-webacl to define a collection of [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 b/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 index be67d4b49..f92ff8e98 100644 --- a/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWAFv2WebACLAssociation.ps1 @@ -105,6 +105,9 @@ The ARN must be in one of the following formats: [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 b/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 index b6b2fa73e..37c647b05 100644 --- a/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 +++ b/VaporShell/Public/Resource Types/New-VSWorkSpacesWorkspace.ps1 @@ -191,6 +191,9 @@ Updates are not supported for the BundleId, RootVolumeEncryptionEnabled, UserVol [ValidateSet("Delete","Retain","Snapshot")] [System.String] $DeletionPolicy, + [ValidateSet("Delete","Retain","Snapshot")] + [System.String] + $UpdateReplacePolicy, [parameter(Mandatory = $false)] [System.String[]] $DependsOn, diff --git a/build.ps1 b/build.ps1 index 4732f6fb8..428bf8c9c 100644 --- a/build.ps1 +++ b/build.ps1 @@ -17,7 +17,7 @@ Param( $NoUpdate, #region: Invoke-Build parameters [Parameter()] - [ValidateSet('Init','Clean','Build','Test','Analyze','Deploy','Full')] + [ValidateSet('Init','Clean','Build','DotnetOnly','Test','Analyze','Deploy','Full')] [string[]] $Task, [Parameter()] diff --git a/ci/Convert-SpecToFunction.ps1 b/ci/Convert-SpecToFunction.ps1 index e6444f1c4..3bfaf1c34 100644 --- a/ci/Convert-SpecToFunction.ps1 +++ b/ci/Convert-SpecToFunction.ps1 @@ -166,7 +166,7 @@ function $FunctionName { else { $Mandatory = '$false' } - if ($Prop.Value.ItemType) {bld + if ($Prop.Value.ItemType) { if ($Prop.Value.ItemType -eq "Tag") { $scriptContents += @" [VaporShell.Core.TransformTag()] diff --git a/invoke.build.ps1 b/invoke.build.ps1 index eb27d3299..34162b62c 100644 --- a/invoke.build.ps1 +++ b/invoke.build.ps1 @@ -96,6 +96,13 @@ Task Update Clean, { } } +# Synopsis: Only compile the dotnet dll +Task DotnetOnly { + Write-BuildLog 'Compiling VaporShell.Core.dll' + dotnet build .\VaporShell.Core\ + Get-Item ".\VaporShell.Core\obj\Debug\netstandard2.0\VaporShell.Core.dll" | Copy-Item -Destination $TargetVersionDirectory -Recurse -ErrorAction SilentlyContinue -Force +} + # Synopsis: Compiles module from source Task Build Update, { $functionsToExport = @() From 0991bbc4c8d30f8aeb6a76b9fb93de369a050764 Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Wed, 4 Mar 2020 15:39:41 +0000 Subject: [PATCH 5/6] Fixes bugs in TransformTag attribute --- Tests/TransformTagAttribute.tests.ps1 | 68 +++++++++++++++++++ VaporShell.Core/VaporShell.Core.cs | 94 ++++++++++++++------------ VaporShell.Core/VaporShell.Core.csproj | 5 +- VaporShell.Core/VaporShell.Core.sln | 25 +++++++ 4 files changed, 145 insertions(+), 47 deletions(-) create mode 100644 Tests/TransformTagAttribute.tests.ps1 create mode 100644 VaporShell.Core/VaporShell.Core.sln diff --git a/Tests/TransformTagAttribute.tests.ps1 b/Tests/TransformTagAttribute.tests.ps1 new file mode 100644 index 000000000..5ce505e25 --- /dev/null +++ b/Tests/TransformTagAttribute.tests.ps1 @@ -0,0 +1,68 @@ +Describe 'TransformTagAttribute' { + BeforeAll { + function Test-TagBinding { + [CmdletBinding()] + param ( + [VaporShell.Core.TransformTag()] + [object[]] $Tags + ) + + $Tags + } + } + + It 'Should return one or more tags when given ' -TestCases @( + @{ + TestName = 'multiple hashtables' + InputData = @{ one = 1 }, @{ two = 2 } + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } + } + @{ + TestName = 'multiple PSObjects' + InputData = [PSCustomObject]@{ one = 1 }, [PSCustomObject]@{ two = 2 } + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } + } + @{ + TestName = 'a single hashtable with multiple keys' + InputData = [PSCustomobject]@{ one = 1; two = 2 } + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } + } + @{ + TestName = 'an existing VSTag object' + InputData = Add-VSTag -Key one -Value '1' + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' } + } + @{ + TestName = 'a hashtable with Key and Value keys' + InputData = @{Key = 'Name'; Value = 'Harold'} + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a hashtable with lowercase key and value keys' + InputData = @{ key = 'Name'; value = 'Harold'} + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a hashtable with mixed case key and value keys' + InputData = @{ kEy = 'Name'; ValUE = 'Harold'} + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a PSCustomObject key and value properties' + InputData = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a PSCustomObject lowercase key and value properties' + InputData = [PSCustomObject]@{ key = 'Name'; value = 'Harold' } + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + ) { + param ( + $InputData, + $ExpectedResult + ) + + Assert-Equivalent -Actual (Test-TagBinding -Tags $InputData) -Expected $ExpectedResult + } +} diff --git a/VaporShell.Core/VaporShell.Core.cs b/VaporShell.Core/VaporShell.Core.cs index 59d9a15f1..4413b0fc3 100644 --- a/VaporShell.Core/VaporShell.Core.cs +++ b/VaporShell.Core/VaporShell.Core.cs @@ -9,33 +9,43 @@ public class TransformTagAttribute : ArgumentTransformationAttribute { private EngineIntrinsics engineIntrinsics; - private IEnumerable ConvertToTag(object key, object value) + private PSObject ConvertToTag(object key, object value) { PSObject tag = new PSObject(); - tag.Members.Add(new PSNoteProperty("Key", key)); - tag.Members.Add(new PSNoteProperty("Value", value)); - tag.TypeNames.Insert(0,"Vaporshell.Resource.Tag"); + tag.Members.Add(new PSNoteProperty("Key", key.ToString())); + tag.Members.Add(new PSNoteProperty("Value", value.ToString())); + tag.TypeNames.Insert(0, "Vaporshell.Resource.Tag"); - yield return tag; + return tag; } - private IEnumerable TransformHashtable(IDictionary inputData) + private bool TryGetKey(IDictionary dictionary, string keyName, ref string KeyValue) { - if (inputData.Contains("Key") && inputData.Contains("Value")) + foreach (object key in dictionary.Keys) { - foreach (PSObject tag in this.ConvertToTag(inputData["Key"],inputData["Value"])) + if (key.ToString().ToLower() == keyName.ToLower()) { - yield return tag; + KeyValue = dictionary[key].ToString(); + return true; } } + + return false; + } + + private IEnumerable TransformHashtable(IDictionary inputData) + { + string keyName = ""; + string value = ""; + if (this.TryGetKey(inputData, "key", ref keyName) && this.TryGetKey(inputData, "value", ref value)) + { + yield return this.ConvertToTag(keyName, value); + } else { foreach (string key in inputData.Keys) { - foreach (PSObject tag in this.ConvertToTag(key,inputData[key])) - { - yield return tag; - } + yield return this.ConvertToTag(key, inputData[key]); } } } @@ -45,80 +55,74 @@ private IEnumerable TransformPSObject(PSObject inputData) var props = new List(); foreach (var property in inputData.Properties) { - props.Add(property.Name); + props.Add(property.Name.ToLower()); } - if (props.Contains("Key") && props.Contains("Value")) - { - object key = null; - object value = null; - foreach (var property in inputData.Properties) - { - if (property.Name == "Key") - { - key = property.Value; - } - else if (property.Name == "Value") - { - value = property.Value; - } - } - foreach (PSObject tag in this.ConvertToTag(key,value)) - { - yield return tag; - } + if (props.Contains("key") && props.Contains("value")) + { + yield return this.ConvertToTag(inputData.Properties["Key"].Value, inputData.Properties["Value"].Value); } else { foreach (var property in inputData.Properties) { - foreach (PSObject tag in this.ConvertToTag(property.Name,property.Value)) - { - yield return tag; - } + yield return this.ConvertToTag(property.Name, property.Value); } } } - private object TransformSingle(object inputData) + private IEnumerable TransformSingle(object inputData) { if (inputData is IDictionary) { - return this.TransformHashtable(inputData as IDictionary); + foreach (PSObject tag in this.TransformHashtable(inputData as IDictionary)) + { + yield return tag; + } } else if (inputData is PSObject) { PSObject psObject = inputData as PSObject; if (psObject.TypeNames.Contains("Vaporshell.Resource.Tag")) { - return inputData; + yield return psObject; } else if (psObject.TypeNames.Contains("System.Management.Automation.PSCustomObject")) { - return this.TransformPSObject(psObject); + foreach (PSObject tag in this.TransformPSObject(psObject)) + { + yield return tag; + } } } - return null; } - private IEnumerable TransformData(object inputData) + private IEnumerable TransformData(object inputData) { if (inputData is Array) { foreach (object item in inputData as Array) { - yield return this.TransformSingle(item); + // This is returning an unenumerated array + foreach (PSObject tag in this.TransformSingle(item)) + { + yield return tag; + } } } else { - yield return this.TransformSingle(inputData); + foreach (PSObject tag in this.TransformSingle(inputData)) + { + yield return tag; + } } } public override object Transform(EngineIntrinsics engineIntrinsics, object inputData) { this.engineIntrinsics = engineIntrinsics; + return this.TransformData(inputData); } } diff --git a/VaporShell.Core/VaporShell.Core.csproj b/VaporShell.Core/VaporShell.Core.csproj index 2d9368eee..dbc4fbfbd 100644 --- a/VaporShell.Core/VaporShell.Core.csproj +++ b/VaporShell.Core/VaporShell.Core.csproj @@ -3,8 +3,9 @@ netstandard2.0 - - + + + diff --git a/VaporShell.Core/VaporShell.Core.sln b/VaporShell.Core/VaporShell.Core.sln new file mode 100644 index 000000000..0878d3480 --- /dev/null +++ b/VaporShell.Core/VaporShell.Core.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29806.167 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VaporShell.Core", "VaporShell.Core.csproj", "{8FF3CC38-B1B4-4F93-8F90-7FDF82AFD193}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {8FF3CC38-B1B4-4F93-8F90-7FDF82AFD193}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8FF3CC38-B1B4-4F93-8F90-7FDF82AFD193}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8FF3CC38-B1B4-4F93-8F90-7FDF82AFD193}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8FF3CC38-B1B4-4F93-8F90-7FDF82AFD193}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {115A389F-865B-4A5F-9761-0E606AB74BF5} + EndGlobalSection +EndGlobal From cd8a0061987bd3d40893c056b862424eb4aad77f Mon Sep 17 00:00:00 2001 From: Nate Ferrell Date: Wed, 4 Mar 2020 11:03:50 -0600 Subject: [PATCH 6/6] !deploy v2.11.0 with multiple fixes and enhancements ## 2.11.0 - 2020-03-04 * [Issue #69](https://github.com/scrthq/VaporShell/issues/69) + [PR #70](https://github.com/scrthq/VaporShell/pull/70) - _Thanks, [@indented-automation](https://github.com/indented-automation)!!!_ * Started `VaporShell.Core` class library to include with the module, first class being `TransformTagAttribute` to cleanly convert `Tags` parameter input to the appropriate format if not already. * Added Pester tests to confirm Tag transforms are working as expected. * [Issue #68](https://github.com/scrthq/VaporShell/issues/68) - _Thanks, [@indented-automation](https://github.com/indented-automation) and [@austoonz](https://github.com/austoonz)!!!_ * Surfaced errors better on AWS SDK errors so the actual error is visible. * Added the `FallbackCredentialFactory` to better support running in environments where credentials files are not a practical option. * Miscellaneous * Updated PseudoParameter list to current spec. * Added newer intrinsic functions `Add-FnCidr` and `Add-FnTransform`. --- CHANGELOG.md | 13 +++ .../TransformTagAttribute.tests.ps1 | 75 ++++++++++++++++++ Tests/TransformTagAttribute.tests.ps1 | 68 ---------------- VaporShell.Core.dll | Bin 11776 -> 0 bytes VaporShell.Core/VaporShell.Core.cs | 10 +-- VaporShell.Core/VaporShell.Core.csproj | 4 +- invoke.build.ps1 | 39 +++++---- 7 files changed, 119 insertions(+), 90 deletions(-) create mode 100644 Tests/Module Tests/TransformTagAttribute.tests.ps1 delete mode 100644 Tests/TransformTagAttribute.tests.ps1 delete mode 100644 VaporShell.Core.dll diff --git a/CHANGELOG.md b/CHANGELOG.md index 32bf1f199..0d152bb97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ +* [2.11.0 - 2020-03-04](#2110---2020-03-04) * [2.10.1 - 2020-02-20](#2101---2020-02-20) * [2.10.0 - 2020-02-18](#2100---2020-02-18) * [2.9.5 - 2020-02-17](#295---2020-02-17) @@ -54,6 +55,18 @@ +## 2.11.0 - 2020-03-04 + +* [Issue #69](https://github.com/scrthq/VaporShell/issues/69) + [PR #70](https://github.com/scrthq/VaporShell/pull/70) - _Thanks, [@indented-automation](https://github.com/indented-automation)!!!_ + * Started `VaporShell.Core` class library to include with the module, first class being `TransformTagAttribute` to cleanly convert `Tags` parameter input to the appropriate format if not already. + * Added Pester tests to confirm Tag transforms are working as expected. +* [Issue #68](https://github.com/scrthq/VaporShell/issues/68) - _Thanks, [@indented-automation](https://github.com/indented-automation) and [@austoonz](https://github.com/austoonz)!!!_ + * Surfaced errors better on AWS SDK errors so the actual error is visible. + * Added the `FallbackCredentialFactory` to better support running in environments where credentials files are not a practical option. +* Miscellaneous + * Updated PseudoParameter list to current spec. + * Added newer intrinsic functions `Add-FnCidr` and `Add-FnTransform`. + ## 2.10.1 - 2020-02-20 * Miscellaneous diff --git a/Tests/Module Tests/TransformTagAttribute.tests.ps1 b/Tests/Module Tests/TransformTagAttribute.tests.ps1 new file mode 100644 index 000000000..b441d6296 --- /dev/null +++ b/Tests/Module Tests/TransformTagAttribute.tests.ps1 @@ -0,0 +1,75 @@ +Describe 'TransformTagAttribute' { + BeforeAll { + function Test-TagBinding { + [CmdletBinding()] + param ( + [VaporShell.Core.TransformTag()] + [object[]] $Tags + ) + + $Tags + } + } + Context 'Confirm TagTransformAttribute works as expected' { + $projectRoot = Resolve-Path "$PSScriptRoot\..\.." + $ModulePath = Resolve-Path "$projectRoot\BuildOutput\$($env:BHProjectName)" + + Write-Verbose "Importing $($env:BHProjectName) module at [$ModulePath]" + Import-Module $ModulePath -Force -Verbose:$false + + It 'Should return one or more tags when given ' -TestCases @( + @{ + TestName = 'multiple hashtables' + InputData = @{ one = 1 }, @{ two = 2 } + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } + } + @{ + TestName = 'multiple PSObjects' + InputData = [PSCustomObject]@{ one = 1 }, [PSCustomObject]@{ two = 2 } + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } + } + @{ + TestName = 'a single hashtable with multiple keys' + InputData = [PSCustomobject]@{ one = 1; two = 2 } + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } + } + @{ + TestName = 'an existing VSTag object' + InputData = Add-VSTag -Key one -Value '1' + ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' } + } + @{ + TestName = 'a hashtable with Key and Value keys' + InputData = @{Key = 'Name'; Value = 'Harold'} + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a hashtable with lowercase key and value keys' + InputData = @{ key = 'Name'; value = 'Harold'} + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a hashtable with mixed case key and value keys' + InputData = @{ kEy = 'Name'; ValUE = 'Harold'} + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a PSCustomObject key and value properties' + InputData = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + @{ + TestName = 'a PSCustomObject lowercase key and value properties' + InputData = [PSCustomObject]@{ key = 'Name'; value = 'Harold' } + ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } + } + ) { + param ( + $InputData, + $ExpectedResult + ) + + Assert-Equivalent -Actual (Test-TagBinding -Tags $InputData) -Expected $ExpectedResult + } + } +} diff --git a/Tests/TransformTagAttribute.tests.ps1 b/Tests/TransformTagAttribute.tests.ps1 deleted file mode 100644 index 5ce505e25..000000000 --- a/Tests/TransformTagAttribute.tests.ps1 +++ /dev/null @@ -1,68 +0,0 @@ -Describe 'TransformTagAttribute' { - BeforeAll { - function Test-TagBinding { - [CmdletBinding()] - param ( - [VaporShell.Core.TransformTag()] - [object[]] $Tags - ) - - $Tags - } - } - - It 'Should return one or more tags when given ' -TestCases @( - @{ - TestName = 'multiple hashtables' - InputData = @{ one = 1 }, @{ two = 2 } - ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } - } - @{ - TestName = 'multiple PSObjects' - InputData = [PSCustomObject]@{ one = 1 }, [PSCustomObject]@{ two = 2 } - ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } - } - @{ - TestName = 'a single hashtable with multiple keys' - InputData = [PSCustomobject]@{ one = 1; two = 2 } - ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' }, [PSCustomObject]@{ Key = 'two'; Value = '2' } - } - @{ - TestName = 'an existing VSTag object' - InputData = Add-VSTag -Key one -Value '1' - ExpectedResult = [PSCustomObject]@{ Key = 'one'; Value = '1' } - } - @{ - TestName = 'a hashtable with Key and Value keys' - InputData = @{Key = 'Name'; Value = 'Harold'} - ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } - } - @{ - TestName = 'a hashtable with lowercase key and value keys' - InputData = @{ key = 'Name'; value = 'Harold'} - ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } - } - @{ - TestName = 'a hashtable with mixed case key and value keys' - InputData = @{ kEy = 'Name'; ValUE = 'Harold'} - ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } - } - @{ - TestName = 'a PSCustomObject key and value properties' - InputData = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } - ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } - } - @{ - TestName = 'a PSCustomObject lowercase key and value properties' - InputData = [PSCustomObject]@{ key = 'Name'; value = 'Harold' } - ExpectedResult = [PSCustomObject]@{ Key = 'Name'; Value = 'Harold' } - } - ) { - param ( - $InputData, - $ExpectedResult - ) - - Assert-Equivalent -Actual (Test-TagBinding -Tags $InputData) -Expected $ExpectedResult - } -} diff --git a/VaporShell.Core.dll b/VaporShell.Core.dll deleted file mode 100644 index e2a24afd80d555d5cf435dbe16a5cba373bcb621..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 11776 zcmeHNeQ;dWbwBU!+qbLL2S}DJfrY)cY$LStB3U+(i7=8affX!USh9>Ax6(>_mKRq0 z#M`$5AvP7`@YSXr(}aGcZR+AM4NYmG^#sb42~DRdX-kH5@<-AE4-C_0m^4E&Wm*Ep z?(dxY-tI~^76YViVw0GpW$Ai({p!M-eqn&6ID3+!^1UZW19>+~|rL>i{n+a^cTqglR=PN`# z53(r#FFk#fNw~H^?>=sf6WzgqSbi-MRe?6tM>MjW_i=cfC|bsk0^ePRCq4UK5BL{0 z0)QvJ`gQ}8D-NrYZqA(qCbo^E!H%}zF1va#T}ju@I1pr8X%RQ;YQtT2^$_hWL#26? zsyK>tS#)8O+6lxmN__ z)tcO-$-vCk743@VU;=EZrBHqaTJ`5bF{|xLQW|Z6msVwBG?cH^%&KTxKSUX;u5cQN zVlH~mI*n+pFl)`WFoh};n|xMBkrl2Dw^fp=Xh8}$57Cp* zgK=xs0!zTZC^R%A%|s*-={gSPs#dj9dXvf_K(RuMH7zi7t^w{o3P;oe1~+qSfIDje zs9fMN5r|w=fTOfZhbb=objJcrGF5|&+YlJAs&$Q8U`FfJxpfe}FF-jSypG_Q@5kD6 zosDXN9Tk^5E7d9;fmmY2D#?+Ur4~3zBva7lOewGvXmh$0*j@`Gw$vc3<&mre!;fS& znuz0Sj6YS3BlBa{+7Ax(Ll2?1+=wo9mfegqFVR6~BB}-XWxbZzNa&a38E8zZM3rz> z3P+lla|ltZ(ZX}zNopIxN^TF5+84BMrqzdadv$x5&LKJA7UIHoRYv*|Ku#Q4%Lo7^ zsuHzbe}+caJrG?Ld;Pn3V9Hq>(+C?)nPO)>Lf%&AQ+Q5=k}y_PMYsPU`lFXx;FVS0 zsTrNhyD;8@0W7Butpe7Hsn&idgC)Arp9v1uWvl=`##amcETFP*I205JSn(cATP?E%vqbc=bg)hHn5NTZ@> zjB0<>0=J!I4q>*S@dNG9c64Kcb_j({9O9>TsL^-m%r6IB*ktDW{luFWR14<-vsf8F zwH0D1i`>|M{``5>0;)(c9TRybs#@TOMX&K%@8#kqVIX=J@#CBGlP}kwZXLt6DnFLU zZqyL)d3|ANLlyE!XNFqfQSvazK+T9)juxH^qNyEVRT2Qr#d_t5EL*;UivC^Dk7V}q zRIguNUZwTRldoj`auw(G%gH9S9Bt%`S>WlFHH-4MWX+5yeYxZ9;gI(XiQpTFCMi0yki=#|$`G zV$QWphS6rC1BuBE2Zbb7fQgV?;0|hm5$8G<$IQo|wO;tXyd>ne&aBiZPp_zv>3t2N zjA>1}W+b44YX<9fALE+A6kRi>U_YxzuuMGG;lb-{nZ2kwW?~L>ZfJY4Wa3NtV39vK@jDXNR~^p86quv@`|PMVg*~pD*QoZiQR`K#(uLI?6;Ux^qVnO z#EVQVh(`;os;tzZ>PV^MIg(Px1YH?0U(%bO1)LVR)Ug;!-BtvNOP!wC`T~on1?eht zfl`N<%d%(UvUqmAjSxe@1yMylNa16(T~BHers)79QB3Kj-CfHk`;M^U!cjEpsZj>Xrm>xxNe-+Q)#5177ak)A}*spO%eVl6~o2!G*86cA& z8PHl{vLVbALp4)sqVCGhFjpd^xu}Ue<7G8b&|*!jkebNdbxq{*RjP@iR%#+2VYw#q zloc4D%?H^6uP3RAuy;vK#QF|uBGyh&6Opz4d64<2i66>&q@j2o!CXl}gPef^tPnZX z5S%wc6hn6j62H>*k7%NB{QwU{mSwS|ky&OQcJfghr;5*mDS23= zJ4s&D?GWQd!MzfF$T%j*o?Ylbi}U?@7Fl4d#e~5HlpS7G+@m3O#twRO?y!)rLXz*# zRSWybEY?ejL`fkVQl_vmP*@-MptoHlYmkE+BUnHme4tZl*A^49OOY9Dby;Qz z3SF#Y7oM?VoON#SG?sEhR7-9k86`J3DDp0W+(01B0=px*fd&oUs%J0@#>%jCY}(*8>HlsNgYxX5#6 zAlg4xx2q0mhmdxdZP=#}A;z8&tP)a;y(d@$trqOl&@zCN-X`>|wWV<1<5V{tWvZ%GgO*k4S1!Z-@8U4ng^{={^Q2;CvrLyhl;E#z{lh#A1{7wkbJ?nh4 z;%sCNnYdkJ#&?k^G3xPoqj;l?(Qco2cX$Dkr+n;{@Xg?TT`(Tq0QR!a~W@_B4o72V}yY*`iM1k;vP(Fvc&mQ~ZMKE{?+)4M3lfo0XS2E~?V z?1e}IyiFRD(W_~*&*RansmteW4u9ULriXouN3VtkUXxryJ5dP?I%QlO)>0J0Y~3A8Y1VbH>$SyYERg}Vm#A>0R$t(-%( zfEKF4`{5W}2Y4lFIm7J&dj$>%yj|cSf%AYX>5l*{dWt+m@>$Yzn@5T~OFuzYKTCPU zrk?&id;|Rr;LWH3EZ+qBChQzcf0T08VSIr6HR~9xWA0-D-=>!h7hI-1N`GwKM~3l! z_&9B)_ly&e|BdKxQ3WU#{Vw``4e-n6(|~_z{RMUVy{4>JsZU1PBP0HtcBvnM%Nn|6 z#H)P8*PB>kPIqPM@W1Dv4}<+(^<2RFxzu?~8!V^liWdeF)e|b&&ZqT?4p_ zS^;kp`Y>P*H00Dc;B#scyT$g z;7bDE5J(}R3+xd%E^txPP3HCp#9oBx__+Pv}ptB-? zj@ksBN9Xs2%cgfeTp-u#Yjz&ohhOHE5tb8>!rmy?}? z)QB?z_7o&ZE1-e?Y<|XeQxh3`yn}{@2kn^&+a1Urb#^(Kj6Lb4oh%rEnCG~__M~$j z9^E@;#>Q?*XH%KXe4ubk(E_y6o;||`pgH2Evbm#vr&!sYXn@!nPrlK$9rMNq2+#L^p+#56j zkMih#N>jUvV%w>E(3#4^6)Kv=Iw99NHkQuL<~>1&=W_@|vJ}u<@>V-*yJ?&wZEtK> z-gWJ)H<-$%rtPVbW3HW=8kmBT3@b@{=~Sjj?46pTtnKBzRCX%mP8H_`@uY#ibZ*wk zacoQW6vJI24dVp>B0Tio)C^?jXKfly%{uPzF*}oiovuy3&1E{1TD=X!I>yFefoIb$ zXJ$5?v0ZTogsEN+?-vt!u=?zY{PZ*%Q=;|ea!9Yt{7Bj>Cl7c?KxEc1>l{o?9!qD- zIu%2U)GetRNx5*~7W{Z<-{ZJnzFMcdNB4auy@pUbI9upnVk3TOp22} zmAO#LoyJdpol{ zX_8Z!jHDGNbjI&nO1nUr&U21qvN!KJI@$qqzkSp%Iy6ukmG(N`aDEmUiWKX=cha8a z$S$c?KoB>ngglAGg@LpRbeHrM*IzQIYe>^>Kjr5aexBW& z%%mUFw2yMB;F^&`N^Kn*^Y9x!XOx$M6@mJ)FpCPkqiA)v+4H$lMg;M=NYCQLz}e(} zJ7;@vc`ofbSx%gbb?_@{dB^25>KEF}?0u=Z{1~mlEV2_HBlZbQ=e7Jl({L&CFQK{I zg>upE9b3l6CiTum1KAu77c}V1*?akK6?$DaHLt4%Tjn;!1@j zi*;=W%a-W+QJnv0$sw0=bc}3#!OGy=wjZq=sCm#Q(N5y@m7-~)gTpirjtANdsDq$p zg~Pawwg+l2`g!O*1CB>&w6dTM(J)T!dFjo(eK@V%i9VB%p~!7$%@b9!JsC*Zav=Mi zpS?VN)!BdPKR(@XUH?=6_1k2|4I>(glMzOvwwBQvZr0(PPRd$Y_e(}yzZu6X1n?%{ zy}+Y!V#W&ern*C6ZZ`q;8ch`uOEsywex)KTb2pS}7&jDDM2seUkc;9O6&>?NT_GG- zMh$D$hyk@0NKt5y7{3ktO-*48x%eov4luYf5($H^6vjy#HG$R{t&bmY zUZP4xy{vHZ+LF@wT#{=i32=SAB7BO*TNRdLKW=W6UHr|u{MtXHGD*4R1d>$2$6NJaTK=J5n;btSJZHBhJK~M`Z4fl%21U0?P%Hvr`i^yt{YH zwj0PF=~F-TM}jvuKR-16r90n!>&>y$)aJvmIJi7+#{+EXGx*CYO&!Alyf2d(#HLC! zxk;SHZ8=$KF22RZDMMf06=`aPOwlrR0fStIh^T&7m2NGC{f9e1H8 zjcShfB!-{L(HV0`!b|1WFCqJpiDd|%N2wqid) z45$ZDGO*L|9y2Rr%)_IU>`$z}wBrqz?RYHj%C56p`UjTxftJG_#dgdVce78TryW(% zDB3*=J-o;2-H`itU{7o>-aJqBkmpG8?&{*nJ7LN4kGDICzpvuGoB#Y!LC+rOm=+D} z*(~-}_Fx(wW4Dz>F(l*d^XVLA9xw2lG2YQH6|d5`I_^Wz=fIY{?CT}#FQtbN3;f=M zQ$l(F_Bo_%y5j`uIv)uVsgdt}=$nBD(x?*B>z{u{&! B=qCUG diff --git a/VaporShell.Core/VaporShell.Core.cs b/VaporShell.Core/VaporShell.Core.cs index 4413b0fc3..2888b4204 100644 --- a/VaporShell.Core/VaporShell.Core.cs +++ b/VaporShell.Core/VaporShell.Core.cs @@ -13,19 +13,19 @@ private PSObject ConvertToTag(object key, object value) { PSObject tag = new PSObject(); tag.Members.Add(new PSNoteProperty("Key", key.ToString())); - tag.Members.Add(new PSNoteProperty("Value", value.ToString())); + tag.Members.Add(new PSNoteProperty("Value", value)); tag.TypeNames.Insert(0, "Vaporshell.Resource.Tag"); return tag; } - private bool TryGetKey(IDictionary dictionary, string keyName, ref string KeyValue) + private bool TryGetKey(IDictionary dictionary, string keyName, ref object KeyValue) { foreach (object key in dictionary.Keys) { if (key.ToString().ToLower() == keyName.ToLower()) { - KeyValue = dictionary[key].ToString(); + KeyValue = dictionary[key]; return true; } } @@ -35,8 +35,8 @@ private bool TryGetKey(IDictionary dictionary, string keyName, ref string KeyVal private IEnumerable TransformHashtable(IDictionary inputData) { - string keyName = ""; - string value = ""; + object keyName = null; + object value = null; if (this.TryGetKey(inputData, "key", ref keyName) && this.TryGetKey(inputData, "value", ref value)) { yield return this.ConvertToTag(keyName, value); diff --git a/VaporShell.Core/VaporShell.Core.csproj b/VaporShell.Core/VaporShell.Core.csproj index dbc4fbfbd..9d29a54ac 100644 --- a/VaporShell.Core/VaporShell.Core.csproj +++ b/VaporShell.Core/VaporShell.Core.csproj @@ -4,8 +4,8 @@ netstandard2.0 - - + + diff --git a/invoke.build.ps1 b/invoke.build.ps1 index 34162b62c..2740ddc30 100644 --- a/invoke.build.ps1 +++ b/invoke.build.ps1 @@ -273,22 +273,31 @@ $pesterScriptBlock = { } } } - $parameters = @{ - Name = 'Pester' - MinimumVersion = '4.8.1' - } - Write-BuildLog "[$($parameters.Name)] Resolving" - try { - if ($imported = Get-Module $($parameters.Name)) { - Write-BuildLog "[$($parameters.Name)] Removing imported module" - $imported | Remove-Module + + $testModules = @( + @{ + Name = 'Pester' + MinimumVersion = '4.10.1' + } + @{ + Name = 'Assert' + MinimumVersion = '0.9.5' + } + ) + foreach ($testModule in $testModules) { + Write-BuildLog "[$($testModule.Name)] Resolving" + try { + if ($imported = Get-Module $($testModule.Name)) { + Write-BuildLog "[$($testModule.Name)] Removing imported module" + $imported | Remove-Module + } + Import-Module @testModule + } + catch { + Write-BuildLog "[$($testModule.Name)] Installing missing module" + Install-Module @testModule + Import-Module @testModule } - Import-Module @parameters - } - catch { - Write-BuildLog "[$($parameters.Name)] Installing missing module" - Install-Module @parameters - Import-Module @parameters } Push-Location Set-Location -PassThru $TargetModuleDirectory